Update docs for 1.4.0 release
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index 15eb1f0..d210ac5 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -85,10 +85,10 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#attachDisk">attachDisk(project, zone, instance, body)</a></code></p>
-<p class="firstline">Attaches a disk resource to an instance.</p>
+<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.</p>
+<p class="firstline">Deletes the specified Instance resource. For more information, see Shutting down 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>
@@ -115,7 +115,7 @@
<p class="firstline">Performs a hard reset on the instance.</p>
<p class="toc_element">
<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="firstline">Sets the auto-delete flag for a disk attached to an instance.</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>
@@ -127,28 +127,28 @@
<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">Starts an instance</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="toc_element">
<code><a href="#stop">stop(project, zone, instance)</a></code></p>
-<p class="firstline">Stops an instance</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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
<pre>Adds an access config to an instance's network interface.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- networkInterface: string, Network interface name. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ networkInterface: string, The name of the network interface to add to this instance. (required)
body: object, The request body. (required)
The object takes the form of:
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
}
@@ -156,36 +156,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -194,9 +194,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -205,7 +205,7 @@
<pre>A description of how to use this function
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -214,52 +214,77 @@
An object of the form:
{
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped instance lists.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": { # [Output Only] A map of scoped instance lists.
"a_key": { # Name of the scope containing this set of instances.
- "instances": [ # List of instances contained in this scope.
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
+ "instances": [ # [Output Only] List of instances contained in this scope.
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, 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.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "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.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "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",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "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.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "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.
+ "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).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
+ "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:
+ #
+ # zones/zone/machineTypes/machine-type
+ "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.
"A String",
@@ -267,51 +292,58 @@
"email": "A String", # Email address of the service account.
},
],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "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.
+ "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
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "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.
+ "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.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
},
],
- "warning": { # Informational warning which replaces the list of instances when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "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.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
},
},
- "kind": "compute#instanceAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "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.
}</pre>
</div>
@@ -331,34 +363,55 @@
<div class="method">
<code class="details" id="attachDisk">attachDisk(project, zone, instance, body)</code>
- <pre>Attaches a disk resource to an instance.
+ <pre>Attaches a Disk resource to an instance.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Instance name. (required)
body: object, The request body. (required)
The object takes the form of:
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "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",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "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.
}
@@ -366,36 +419,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -404,55 +457,55 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, zone, instance)</code>
- <pre>Deletes the specified instance resource.
+ <pre>Deletes the specified Instance resource. For more information, see Shutting down an instance.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ 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 resource to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -461,9 +514,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -472,46 +525,46 @@
<pre>Deletes an access config from an instance's network interface.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- accessConfig: string, Access config name. (required)
- networkInterface: string, Network interface name. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ accessConfig: string, The name of the access config to delete. (required)
+ networkInterface: string, The name of the network interface. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -520,9 +573,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -531,8 +584,8 @@
<pre>Detaches a disk from an instance.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Instance name. (required)
deviceName: string, Disk device name to detach. (required)
@@ -540,36 +593,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -578,9 +631,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -589,55 +642,80 @@
<pre>Returns the specified instance resource.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the The name of the zone for this request.. (required)
instance: string, Name of the instance resource to return. (required)
Returns:
An object of the form:
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, 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.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "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.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "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",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "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.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "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.
+ "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).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
+ "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:
+ #
+ # zones/zone/machineTypes/machine-type
+ "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.
"A String",
@@ -645,33 +723,40 @@
"email": "A String", # Email address of the service account.
},
],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "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.
+ "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
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "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.
+ "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.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
}</pre>
</div>
@@ -681,17 +766,17 @@
<pre>Returns the specified instance's serial port output.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ 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)
Returns:
An object of the form:
- { # An instance serial console output.
- "kind": "compute#serialPortOutput", # Type of the resource.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "contents": "A String", # The contents of the console output.
+ { # 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.
+ "contents": "A String", # [Output Only] The contents of the console output.
}</pre>
</div>
@@ -700,53 +785,78 @@
<pre>Creates an instance resource in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
+{ # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, 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.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "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.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "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",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "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.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "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.
+ "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).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
+ "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:
+ #
+ # zones/zone/machineTypes/machine-type
+ "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.
"A String",
@@ -754,33 +864,40 @@
"email": "A String", # Email address of the service account.
},
],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "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.
+ "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
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "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.
+ "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.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
}
@@ -789,36 +906,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -827,9 +944,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -838,8 +955,8 @@
<pre>Retrieves the list of instance resources contained within the specified zone.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -848,50 +965,75 @@
An object of the form:
{ # Contains a list of instance resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Instance resources.
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Instance resources.
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, 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.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "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.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "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",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "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.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "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.
+ "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).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
+ "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:
+ #
+ # zones/zone/machineTypes/machine-type
+ "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.
"A String",
@@ -899,39 +1041,46 @@
"email": "A String", # Email address of the service account.
},
],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "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.
+ "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
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "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.
+ "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.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
},
],
- "kind": "compute#instanceList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "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.
}</pre>
</div>
@@ -954,44 +1103,44 @@
<pre>Performs a hard reset on the instance.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ 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)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1000,57 +1149,57 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</code>
- <pre>Sets the auto-delete flag for a disk attached to an instance
+ <pre>Sets the auto-delete flag for a disk attached to an instance.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name. (required)
autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
- deviceName: string, Disk device name to modify. (required)
+ deviceName: string, The device name of the disk to modify. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1059,9 +1208,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -1070,8 +1219,8 @@
<pre>Sets metadata for the specified instance to the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ 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:
@@ -1083,8 +1232,8 @@
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}
@@ -1092,36 +1241,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1130,9 +1279,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -1141,15 +1290,15 @@
<pre>Sets an instance's scheduling options.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Instance name. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Scheduling options for an Instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+{ # 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).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
}
@@ -1157,36 +1306,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1195,9 +1344,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -1206,8 +1355,8 @@
<pre>Sets tags for the specified instance to the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ 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:
@@ -1216,7 +1365,9 @@
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
}
@@ -1224,36 +1375,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1262,55 +1413,55 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="start">start(project, zone, instance)</code>
- <pre>Starts an instance
+ <pre>This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ 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 resource to start. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1319,55 +1470,55 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="stop">stop(project, zone, instance)</code>
- <pre>Stops an instance
+ <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.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ 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 resource to start. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1376,9 +1527,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>