Update docs for 1.4.0 release
diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html
index cec70e0..0334cf8 100644
--- a/docs/dyn/compute_v1.instanceTemplates.html
+++ b/docs/dyn/compute_v1.instanceTemplates.html
@@ -102,36 +102,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.
@@ -140,9 +140,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>
@@ -169,33 +169,56 @@
"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 instance created based on this template.
{ # 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.
},
],
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
- "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.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "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.
},
"canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances 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.
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
@@ -213,22 +236,29 @@
"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.
},
"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 instances created based based on this template will have no external internet access.
{ # 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
},
],
},
@@ -258,33 +288,56 @@
"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 instance created based on this template.
{ # 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.
},
],
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
- "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.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "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.
},
"canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances 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.
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
@@ -302,22 +355,29 @@
"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.
},
"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 instances created based based on this template will have no external internet access.
{ # 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
},
],
},
@@ -330,36 +390,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.
@@ -368,9 +428,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>
@@ -402,33 +462,56 @@
"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 instance created based on this template.
{ # 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.
},
],
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
- "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.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "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.
},
"canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances 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.
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
@@ -446,22 +529,29 @@
"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.
},
"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 instances created based based on this template will have no external internet access.
{ # 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
},
],
},