Updated docs
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index 36290bb..d162f52 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -79,7 +79,7 @@
<p class="firstline">Adds an access config to an instance's network interface.</p>
<p class="toc_element">
<code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">A description of how to use this function</p>
+<p class="firstline">Retrieves aggregated list of instances.</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>
@@ -88,7 +88,7 @@
<p class="firstline">Attaches a Disk resource to an instance.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, zone, instance)</a></code></p>
-<p class="firstline">Deletes the specified Instance resource. For more information, see Shutting down an instance.</p>
+<p class="firstline">Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.</p>
<p class="toc_element">
<code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</a></code></p>
<p class="firstline">Deletes an access config from an instance's network interface.</p>
@@ -97,7 +97,7 @@
<p class="firstline">Detaches a disk from an instance.</p>
<p class="toc_element">
<code><a href="#get">get(project, zone, instance)</a></code></p>
-<p class="firstline">Returns the specified instance resource.</p>
+<p class="firstline">Returns the specified Instance resource.</p>
<p class="toc_element">
<code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None)</a></code></p>
<p class="firstline">Returns the specified instance's serial port output.</p>
@@ -106,7 +106,7 @@
<p class="firstline">Creates an instance 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 instance resources contained within the specified zone.</p>
+<p class="firstline">Retrieves the list of instances 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>
@@ -117,6 +117,9 @@
<code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</a></code></p>
<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
<p class="toc_element">
+ <code><a href="#setMachineType">setMachineType(project, zone, instance, body)</a></code></p>
+<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p>
+<p class="toc_element">
<code><a href="#setMetadata">setMetadata(project, zone, instance, body)</a></code></p>
<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
<p class="toc_element">
@@ -127,10 +130,10 @@
<p class="firstline">Sets tags for the specified instance to the data included in the request.</p>
<p class="toc_element">
<code><a href="#start">start(project, zone, instance)</a></code></p>
-<p class="firstline">This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
+<p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
<p class="toc_element">
<code><a href="#stop">stop(project, zone, instance)</a></code></p>
-<p class="firstline">This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>
+<p class="firstline">Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
@@ -156,35 +159,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -194,40 +199,44 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
<div class="method">
<code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
- <pre>A description of how to use this function
+ <pre>Retrieves aggregated list of instances.
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
- filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
{
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
"items": { # [Output Only] A map of scoped instance lists.
- "a_key": { # Name of the scope containing this set of instances.
+ "a_key": { # [Output Only] Name of the scope containing this set of instances.
"instances": [ # [Output Only] List of instances contained in this scope.
{ # An Instance resource.
"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance resides.
"tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
@@ -275,21 +284,29 @@
"A String",
],
"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
- "interface": "A String",
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "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.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
"preemptible": True or False, # Whether the instance is preemptible.
- "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
},
- "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
#
- # zones/zone/machineTypes/machine-type
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
{ # A service account.
"scopes": [ # The list of scopes to be made available for this service account.
@@ -310,6 +327,9 @@
],
"networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
+ # - zones/zone/subnetworks/subnetwork
"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
#
# global/networks/default
@@ -321,8 +341,8 @@
},
],
"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 this resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
@@ -336,20 +356,21 @@
},
],
"warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
- "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.
+ "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 for the warning data.
+ "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).
},
],
},
},
},
"kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for this resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -374,7 +395,7 @@
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
- instance: string, Instance name. (required)
+ instance: string, The instance name for this request. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -415,7 +436,7 @@
"A String",
],
"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
- "interface": "A String",
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
}
@@ -425,35 +446,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -463,15 +486,15 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, zone, instance)</code>
- <pre>Deletes the specified Instance resource. For more information, see Shutting down an instance.
+ <pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
Args:
project: string, Project ID for this request. (required)
@@ -482,35 +505,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -520,9 +545,9 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
@@ -541,35 +566,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -579,9 +606,9 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
@@ -599,35 +626,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -637,15 +666,15 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, zone, instance)</code>
- <pre>Returns the specified instance resource.
+ <pre>Returns the specified Instance resource.
Args:
project: string, Project ID for this request. (required)
@@ -660,7 +689,7 @@
"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance resides.
"tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
@@ -708,21 +737,29 @@
"A String",
],
"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
- "interface": "A String",
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "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.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
"preemptible": True or False, # Whether the instance is preemptible.
- "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
},
- "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
#
- # zones/zone/machineTypes/machine-type
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
{ # A service account.
"scopes": [ # The list of scopes to be made available for this service account.
@@ -743,6 +780,9 @@
],
"networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
+ # - zones/zone/subnetworks/subnetwork
"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
#
# global/networks/default
@@ -754,8 +794,8 @@
},
],
"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 this resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
@@ -784,7 +824,7 @@
{ # An instance's serial console output.
"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"contents": "A String", # [Output Only] The contents of the console output.
}</pre>
</div>
@@ -804,7 +844,7 @@
"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance resides.
"tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
@@ -852,21 +892,29 @@
"A String",
],
"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
- "interface": "A String",
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "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.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
"preemptible": True or False, # Whether the instance is preemptible.
- "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
},
- "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
#
- # zones/zone/machineTypes/machine-type
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
{ # A service account.
"scopes": [ # The list of scopes to be made available for this service account.
@@ -887,6 +935,9 @@
],
"networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
+ # - zones/zone/subnetworks/subnetwork
"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
#
# global/networks/default
@@ -898,8 +949,8 @@
},
],
"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 this resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
@@ -917,35 +968,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -955,39 +1008,43 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</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 instance resources contained within the specified zone.
+ <pre>Retrieves the list of instances contained within the specified zone.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
- filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # Contains a list of instance resources.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "items": [ # [Output Only] A list of Instance resources.
+ { # Contains a list of instances.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of instances.
{ # An Instance resource.
"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance resides.
"tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
@@ -1035,21 +1092,29 @@
"A String",
],
"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
- "interface": "A String",
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "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.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
"preemptible": True or False, # Whether the instance is preemptible.
- "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
},
- "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
#
- # zones/zone/machineTypes/machine-type
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
{ # A service account.
"scopes": [ # The list of scopes to be made available for this service account.
@@ -1070,6 +1135,9 @@
],
"networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
+ # - zones/zone/subnetworks/subnetwork
"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
#
# global/networks/default
@@ -1081,8 +1149,8 @@
},
],
"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 this resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
@@ -1096,8 +1164,8 @@
},
],
"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for this resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -1128,35 +1196,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -1166,9 +1236,9 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
@@ -1187,35 +1257,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -1225,9 +1297,75 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setMachineType">setMachineType(project, zone, instance, body)</code>
+ <pre>Changes the machine type for a stopped instance to the machine type specified in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
+ }
+
+
+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 which 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.
}</pre>
</div>
@@ -1258,35 +1396,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -1296,9 +1436,9 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
@@ -1316,7 +1456,7 @@
{ # Sets the scheduling options for an Instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
"preemptible": True or False, # Whether the instance is preemptible.
- "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
}
@@ -1324,35 +1464,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -1362,9 +1504,9 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
@@ -1393,35 +1535,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -1431,15 +1575,15 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
<div class="method">
<code class="details" id="start">start(project, zone, instance)</code>
- <pre>This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
+ <pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
Args:
project: string, Project ID for this request. (required)
@@ -1450,35 +1594,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -1488,15 +1634,15 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
<div class="method">
<code class="details" id="stop">stop(project, zone, instance)</code>
- <pre>This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.
+ <pre>Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
Args:
project: string, Project ID for this request. (required)
@@ -1507,35 +1653,37 @@
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.
+ "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] 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.
+ "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 at 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 message that was returned, such as 404.
+ "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] 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.
+ "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] 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.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -1545,9 +1693,9 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>