docs/dyn/compute_v1.projects.html - external/github.com/google/google-api-python-client - Git at Google

 <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.projects.html">projects</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#get">get(project)</a></code></p>
 <p class="firstline">Returns the specified Project resource.</p>
 <p class="toc_element">
   <code><a href="#moveDisk">moveDisk(project, body)</a></code></p>
 <p class="firstline">Moves a persistent disk from one zone to another.</p>
 <p class="toc_element">
   <code><a href="#moveInstance">moveInstance(project, body)</a></code></p>
 <p class="firstline">Moves an instance and its attached persistent disks from one zone to another.</p>
 <p class="toc_element">
   <code><a href="#setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</a></code></p>
 <p class="firstline">Sets metadata common to all instances within the specified project using the data included in the request.</p>
 <p class="toc_element">
   <code><a href="#setUsageExportBucket">setUsageExportBucket(project, body)</a></code></p>
 <p class="firstline">Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="get">get(project)</code>
   <pre>Returns the specified Project resource.

 Args:
   project: string, Project ID for this request. (required)

 Returns:
   An object of the form:

     { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
     "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
     "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
     "enabledFeatures": [ # Restricted features enabled for use on this project.
       "A String",
     ],
     "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
       "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
         {
           "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
           "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
         },
       ],
       "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
       "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
     },
     "quotas": [ # [Output Only] Quotas assigned to this project.
       { # A quotas entry.
         "usage": 3.14, # [Output Only] Current usage of this metric.
         "metric": "A String", # [Output Only] Name of the quota metric.
         "limit": 3.14, # [Output Only] Quota limit for this metric.
       },
     ],
     "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
     "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
         "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
         "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
       },
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "description": "A String", # An optional textual description of the resource.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="moveDisk">moveDisk(project, body)</code>
   <pre>Moves a persistent disk from one zone to another.

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

 {
     "targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:
         # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
         # - projects/project/zones/zone/disks/disk
         # - zones/zone/disks/disk
     "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
         # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
         # - projects/project/zones/zone
         # - zones/zone
   }


 Returns:
   An object of the form:

     { # An Operation resource, used to manage asynchronous API requests.
     "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
     "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
     "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
     "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
     "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
     "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
     "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
         "message": "A String", # [Output Only] A human-readable description of the warning code.
         "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
         "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
             # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
             "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
           },
         ],
       },
     ],
     "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
     "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 that caused the error. This property is optional.
         },
       ],
     },
     "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="moveInstance">moveInstance(project, body)</code>
   <pre>Moves an instance and its attached persistent disks from one zone to another.

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

 {
     "targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:
         # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
         # - projects/project/zones/zone/instances/instance
         # - zones/zone/instances/instance
     "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
         # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
         # - projects/project/zones/zone
         # - zones/zone
   }


 Returns:
   An object of the form:

     { # An Operation resource, used to manage asynchronous API requests.
     "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
     "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
     "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
     "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
     "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
     "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
     "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
         "message": "A String", # [Output Only] A human-readable description of the warning code.
         "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
         "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
             # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
             "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
           },
         ],
       },
     ],
     "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
     "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 that caused the error. This property is optional.
         },
       ],
     },
     "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</code>
   <pre>Sets metadata common to all instances within 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:

 { # A metadata key/value entry.
   "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
     {
       "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
       "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
     },
   ],
   "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
   "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
 }


 Returns:
   An object of the form:

     { # An Operation resource, used to manage asynchronous API requests.
     "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
     "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
     "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
     "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
     "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
     "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
     "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
         "message": "A String", # [Output Only] A human-readable description of the warning code.
         "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
         "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
             # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
             "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
           },
         ],
       },
     ],
     "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
     "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 that caused the error. This property is optional.
         },
       ],
     },
     "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="setUsageExportBucket">setUsageExportBucket(project, body)</code>
   <pre>Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

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

 { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
     "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
     "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
   }


 Returns:
   An object of the form:

     { # An Operation resource, used to manage asynchronous API requests.
     "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
     "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
     "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
     "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
     "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
     "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
     "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
     "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
         "message": "A String", # [Output Only] A human-readable description of the warning code.
         "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
         "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
             # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
             "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
           },
         ],
       },
     ],
     "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
     "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 that caused the error. This property is optional.
         },
       ],
     },
     "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
   }</pre>
 </div>

 </body></html>