docs/dyn/compute_v1.images.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.images.html">images</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(project, image)</a></code></p>
 <p class="firstline">Deletes the specified image resource.</p>
 <p class="toc_element">
   <code><a href="#deprecate">deprecate(project, image, body)</a></code></p>
 <p class="firstline">Sets the deprecation status of an image.</p>
 <p class="toc_element">
   <code><a href="#get">get(project, image)</a></code></p>
 <p class="firstline">Returns the specified image resource.</p>
 <p class="toc_element">
   <code><a href="#insert">insert(project, body)</a></code></p>
 <p class="firstline">Creates an image resource in the specified project using the data included in the request.</p>
 <p class="toc_element">
   <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
 <p class="firstline">Retrieves the list of image resources available to the specified project.</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="delete">delete(project, image)</code>
   <pre>Deletes the specified image resource.

 Args:
   project: string, Project ID for this request. (required)
   image: string, Name of the image 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", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "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.
     "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
     "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
     "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
     "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 RFC3339 text format.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
         "message": "A String", # [Output Only] Optional human-readable details for this warning.
         "code": "A String", # [Output Only] The warning type identifier for this warning.
         "data": [ # [Output Only] Metadata for this warning in key: value format.
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
             "key": "A String", # [Output Only] A key for the warning data.
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
     "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
     "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
     "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
     "error": { # [Output Only] If errors are generated during processing of the 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", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
     "selfLink": "A String", # [Output Only] Server defined URL for the resource.
     "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="deprecate">deprecate(project, image, body)</code>
   <pre>Sets the deprecation status of an image.

 If an empty request body is given, clears the deprecation status instead.

 Args:
   project: string, Project ID for this request. (required)
   image: string, Image name. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # Deprecation status for a public resource.
   "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
   "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
   "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
   "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
   "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
 }


 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", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "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.
     "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
     "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
     "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
     "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 RFC3339 text format.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
         "message": "A String", # [Output Only] Optional human-readable details for this warning.
         "code": "A String", # [Output Only] The warning type identifier for this warning.
         "data": [ # [Output Only] Metadata for this warning in key: value format.
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
             "key": "A String", # [Output Only] A key for the warning data.
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
     "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
     "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
     "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
     "error": { # [Output Only] If errors are generated during processing of the 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", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
     "selfLink": "A String", # [Output Only] Server defined URL for the resource.
     "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
   }</pre>
 </div>

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

 Args:
   project: string, Project ID for this request. (required)
   image: string, Name of the image resource to return. (required)

 Returns:
   An object of the form:

     { # An Image resource.
       "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
       "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
       "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
       "rawDisk": { # The parameters of the raw disk image.
         "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
         "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
         "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
       },
       "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
         "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
         "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
         "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
         "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
         "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
       },
       "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
       "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
       "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
       "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
           # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
           # - projects/project/zones/zone/disk/disk
           # - zones/zone/disks/disk
       "licenses": [ # Any applicable publicly visible licenses.
         "A String",
       ],
       "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
       "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
       "selfLink": "A String", # [Output Only] Server defined URL for the resource.
       "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="insert">insert(project, body)</code>
   <pre>Creates an image resource in the specified project using the data included in the request.

 Args:
   project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # An Image resource.
     "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
     "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
     "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
     "rawDisk": { # The parameters of the raw disk image.
       "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
       "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
       "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
     },
     "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
       "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
       "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
       "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
       "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
       "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
     },
     "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
     "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
     "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
     "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
         # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
         # - projects/project/zones/zone/disk/disk
         # - zones/zone/disks/disk
     "licenses": [ # Any applicable publicly visible licenses.
       "A String",
     ],
     "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
     "selfLink": "A String", # [Output Only] Server defined URL for the resource.
     "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }


 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", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "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.
     "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
     "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
     "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
     "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 RFC3339 text format.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
         "message": "A String", # [Output Only] Optional human-readable details for this warning.
         "code": "A String", # [Output Only] The warning type identifier for this warning.
         "data": [ # [Output Only] Metadata for this warning in key: value format.
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
             "key": "A String", # [Output Only] A key for the warning data.
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
     "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
     "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
     "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
     "error": { # [Output Only] If errors are generated during processing of the 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", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
     "selfLink": "A String", # [Output Only] Server defined URL for the resource.
     "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
   <pre>Retrieves the list of image resources available to the specified project.

 Args:
   project: string, Project ID for 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 Image resources.
     "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
     "items": [ # A list of Image resources.
       { # An Image resource.
           "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
           "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
           "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
           "rawDisk": { # The parameters of the raw disk image.
             "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
             "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
             "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
           },
           "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
             "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
             "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
             "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
             "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
             "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
           },
           "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
           "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
           "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
           "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
               # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
               # - projects/project/zones/zone/disk/disk
               # - zones/zone/disks/disk
           "licenses": [ # Any applicable publicly visible licenses.
             "A String",
           ],
           "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
           "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
           "selfLink": "A String", # [Output Only] Server defined URL for the resource.
           "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
     "kind": "compute#imageList", # 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>