docs/dyn/compute_v1.disks.html - platform/external/python/google-api-python-client - Gitiles

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.disks.html">disks</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
 <p class="firstline">Retrieves the list of disks grouped by scope.</p>
 <p class="toc_element">
   <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <p class="toc_element">
   <code><a href="#createSnapshot">createSnapshot(project, zone, disk, body)</a></code></p>
 <p class="firstline">A description of how to use this function</p>
 <p class="toc_element">
   <code><a href="#delete">delete(project, zone, disk)</a></code></p>
 <p class="firstline">Deletes the specified persistent disk resource.</p>
 <p class="toc_element">
   <code><a href="#get">get(project, zone, disk)</a></code></p>
 <p class="firstline">Returns the specified persistent disk resource.</p>
 <p class="toc_element">
   <code><a href="#insert">insert(project, zone, body, sourceImage=None)</a></code></p>
 <p class="firstline">Creates a persistent disk resource in the specified project using the data included in the request.</p>
 <p class="toc_element">
   <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
 <p class="firstline">Retrieves the list of persistent disk resources contained within the specified zone.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
   <pre>Retrieves the list of disks grouped by scope.

 Args:
   project: string, Name of the project scoping this request. (required)
   maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
   pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
   filter: string, Optional. Filter expression for filtering listed resources.

 Returns:
   An object of the form:

     {
     "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
     "items": { # A map of scoped disk lists.
       "a_key": { # Name of the scope containing this set of disks.
         "disks": [ # List of disks contained in this scope.
           { # A persistent disk resource.
               "status": "A String", # The status of disk creation (output only).
               "sourceSnapshot": "A String", # The source snapshot used to create this disk.
               "kind": "compute#disk", # Type of the resource.
               "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
               "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
               "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
               "options": "A String", # Internal use only.
               "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
               "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
               "sourceImage": "A String", # The source image used to create this disk.
               "licenses": [ # Public visible licenses.
                 "A String",
               ],
               "zone": "A String", # URL of the zone where the disk resides (output only).
               "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
               "id": "A String", # Unique identifier for the resource; defined by the server (output only).
               "selfLink": "A String", # Server defined URL for the resource (output only).
               "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
             },
         ],
         "warning": { # Informational warning which replaces the list of disks when the list is empty.
           "message": "A String", # Optional human-readable details for this warning.
           "code": "A String", # The warning type identifier for this warning.
           "data": [ # Metadata for this warning in 'key: value' format.
             {
               "value": "A String", # A warning data value corresponding to the key.
               "key": "A String", # A key for the warning data.
             },
           ],
         },
       },
     },
     "kind": "compute#diskAggregatedList", # Type of resource.
     "id": "A String", # Unique identifier for the resource; defined by the server (output only).
     "selfLink": "A String", # Server defined URL for this resource (output only).
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
   <pre>Retrieves the next page of results.

 Args:
   previous_request: The request for the previous page. (required)
   previous_response: The response from the request for the previous page. (required)

 Returns:
   A request object that you can call 'execute()' on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 <div class="method">
     <code class="details" id="createSnapshot">createSnapshot(project, zone, disk, body)</code>
   <pre>A description of how to use this function

 Args:
   project: string, Name of the project scoping this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   disk: string, Name of the persistent disk resource to snapshot. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # A persistent disk snapshot resource.
     "status": "A String", # The status of the persistent disk snapshot (output only).
     "kind": "compute#snapshot", # Type of the resource.
     "storageBytes": "A String", # A size of the the storage used by the snapshot. As snapshots share storage this number is expected to change with snapshot creation/deletion.
     "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
     "sourceDisk": "A String", # The source disk used to create this snapshot.
     "storageBytesStatus": "A String", # An indicator whether storageBytes is in a stable state, or it is being adjusted as a result of shared storage reallocation.
     "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
     "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
     "licenses": [ # Public visible licenses.
       "A String",
     ],
     "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
     "id": "A String", # Unique identifier for the resource; defined by the server (output only).
     "selfLink": "A String", # Server defined URL for the resource (output only).
     "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
   }


 Returns:
   An object of the form:

     { # An operation resource, used to manage asynchronous API requests.
     "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
     "clientOperationId": "A String",
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
     "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
     "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
     "operationType": "A String",
     "httpErrorMessage": "A String",
     "progress": 42,
     "httpErrorStatusCode": 42,
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
     "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
     "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
     "warnings": [
       {
         "message": "A String", # Optional human-readable details for this warning.
         "code": "A String", # The warning type identifier for this warning.
         "data": [ # Metadata for this warning in 'key: value' format.
           {
             "value": "A String", # A warning data value corresponding to the key.
             "key": "A String", # A key for the warning data.
           },
         ],
       },
     ],
     "user": "A String",
     "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
     "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource (output only).
     "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
     "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
           "message": "A String", # [Output Only] An optional, human-readable error message.
           "code": "A String", # [Output Only] The error type identifier for this error.
           "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
         },
       ],
     },
     "endTime": "A String",
     "selfLink": "A String", # [Output Only] Server defined URL for the resource.
     "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="delete">delete(project, zone, disk)</code>
   <pre>Deletes the specified persistent disk resource.

 Args:
   project: string, Name of the project scoping this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   disk: string, Name of the persistent disk resource to delete. (required)

 Returns:
   An object of the form:

     { # An operation resource, used to manage asynchronous API requests.
     "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
     "clientOperationId": "A String",
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
     "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
     "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
     "operationType": "A String",
     "httpErrorMessage": "A String",
     "progress": 42,
     "httpErrorStatusCode": 42,
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
     "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
     "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
     "warnings": [
       {
         "message": "A String", # Optional human-readable details for this warning.
         "code": "A String", # The warning type identifier for this warning.
         "data": [ # Metadata for this warning in 'key: value' format.
           {
             "value": "A String", # A warning data value corresponding to the key.
             "key": "A String", # A key for the warning data.
           },
         ],
       },
     ],
     "user": "A String",
     "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
     "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource (output only).
     "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
     "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
           "message": "A String", # [Output Only] An optional, human-readable error message.
           "code": "A String", # [Output Only] The error type identifier for this error.
           "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
         },
       ],
     },
     "endTime": "A String",
     "selfLink": "A String", # [Output Only] Server defined URL for the resource.
     "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(project, zone, disk)</code>
   <pre>Returns the specified persistent disk resource.

 Args:
   project: string, Name of the project scoping this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   disk: string, Name of the persistent disk resource to return. (required)

 Returns:
   An object of the form:

     { # A persistent disk resource.
       "status": "A String", # The status of disk creation (output only).
       "sourceSnapshot": "A String", # The source snapshot used to create this disk.
       "kind": "compute#disk", # Type of the resource.
       "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
       "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
       "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
       "options": "A String", # Internal use only.
       "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
       "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
       "sourceImage": "A String", # The source image used to create this disk.
       "licenses": [ # Public visible licenses.
         "A String",
       ],
       "zone": "A String", # URL of the zone where the disk resides (output only).
       "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
       "id": "A String", # Unique identifier for the resource; defined by the server (output only).
       "selfLink": "A String", # Server defined URL for the resource (output only).
       "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="insert">insert(project, zone, body, sourceImage=None)</code>
   <pre>Creates a persistent disk resource in the specified project using the data included in the request.

 Args:
   project: string, Name of the project scoping this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # A persistent disk resource.
     "status": "A String", # The status of disk creation (output only).
     "sourceSnapshot": "A String", # The source snapshot used to create this disk.
     "kind": "compute#disk", # Type of the resource.
     "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
     "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
     "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
     "options": "A String", # Internal use only.
     "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
     "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
     "sourceImage": "A String", # The source image used to create this disk.
     "licenses": [ # Public visible licenses.
       "A String",
     ],
     "zone": "A String", # URL of the zone where the disk resides (output only).
     "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
     "id": "A String", # Unique identifier for the resource; defined by the server (output only).
     "selfLink": "A String", # Server defined URL for the resource (output only).
     "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
   }

   sourceImage: string, Optional. Source image to restore onto a disk.

 Returns:
   An object of the form:

     { # An operation resource, used to manage asynchronous API requests.
     "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
     "clientOperationId": "A String",
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
     "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
     "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
     "operationType": "A String",
     "httpErrorMessage": "A String",
     "progress": 42,
     "httpErrorStatusCode": 42,
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
     "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
     "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
     "warnings": [
       {
         "message": "A String", # Optional human-readable details for this warning.
         "code": "A String", # The warning type identifier for this warning.
         "data": [ # Metadata for this warning in 'key: value' format.
           {
             "value": "A String", # A warning data value corresponding to the key.
             "key": "A String", # A key for the warning data.
           },
         ],
       },
     ],
     "user": "A String",
     "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
     "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource (output only).
     "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
     "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
           "message": "A String", # [Output Only] An optional, human-readable error message.
           "code": "A String", # [Output Only] The error type identifier for this error.
           "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
         },
       ],
     },
     "endTime": "A String",
     "selfLink": "A String", # [Output Only] Server defined URL for the resource.
     "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
   <pre>Retrieves the list of persistent disk resources contained within the specified zone.

 Args:
   project: string, Name of the project scoping this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
   pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
   filter: string, Optional. Filter expression for filtering listed resources.

 Returns:
   An object of the form:

     { # Contains a list of persistent disk resources.
     "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
     "items": [ # A list of Disk resources.
       { # A persistent disk resource.
           "status": "A String", # The status of disk creation (output only).
           "sourceSnapshot": "A String", # The source snapshot used to create this disk.
           "kind": "compute#disk", # Type of the resource.
           "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
           "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
           "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
           "options": "A String", # Internal use only.
           "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
           "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
           "sourceImage": "A String", # The source image used to create this disk.
           "licenses": [ # Public visible licenses.
             "A String",
           ],
           "zone": "A String", # URL of the zone where the disk resides (output only).
           "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
           "id": "A String", # Unique identifier for the resource; defined by the server (output only).
           "selfLink": "A String", # Server defined URL for the resource (output only).
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
         },
     ],
     "kind": "compute#diskList", # Type of resource.
     "id": "A String", # Unique identifier for the resource; defined by the server (output only).
     "selfLink": "A String", # Server defined URL for this resource (output only).
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   <pre>Retrieves the next page of results.

 Args:
   previous_request: The request for the previous page. (required)
   previous_response: The response from the request for the previous page. (required)

 Returns:
   A request object that you can call 'execute()' on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 </body></html>