Update docs
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index d162f52..b946e7c 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -97,7 +97,7 @@
<p class="firstline">Detaches a disk from an instance.</p>
<p class="toc_element">
<code><a href="#get">get(project, zone, instance)</a></code></p>
-<p class="firstline">Returns the specified Instance resource.</p>
+<p class="firstline">Returns the specified Instance resource. Get a list of available instances by making a list() request.</p>
<p class="toc_element">
<code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None)</a></code></p>
<p class="firstline">Returns the specified instance's serial port output.</p>
@@ -180,7 +180,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -195,7 +195,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -217,11 +217,11 @@
The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
-For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
@@ -238,7 +238,7 @@
"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 description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance resides.
- "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "tags": { # A set of instance tags. # A list of tags to apply 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",
],
@@ -259,15 +259,23 @@
# 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:
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
#
# 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:
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
#
- # 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.
+ # global/images/family/my-private-family
"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
@@ -325,11 +333,11 @@
"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", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
- # - zones/zone/subnetworks/subnetwork
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
#
# global/networks/default
@@ -362,7 +370,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -411,15 +419,23 @@
# 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:
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
#
# 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:
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
#
- # 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.
+ # global/images/family/my-private-family
"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
@@ -467,7 +483,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -482,7 +498,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -526,7 +542,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -541,7 +557,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -587,7 +603,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -602,7 +618,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -647,7 +663,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -662,7 +678,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -674,7 +690,7 @@
<div class="method">
<code class="details" id="get">get(project, zone, instance)</code>
- <pre>Returns the specified Instance resource.
+ <pre>Returns the specified Instance resource. Get a list of available instances by making a list() request.
Args:
project: string, Project ID for this request. (required)
@@ -691,7 +707,7 @@
"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 description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance resides.
- "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "tags": { # A set of instance tags. # A list of tags to apply 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",
],
@@ -712,15 +728,23 @@
# 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:
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
#
# 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:
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
#
- # 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.
+ # global/images/family/my-private-family
"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
@@ -778,11 +802,11 @@
"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", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
- # - zones/zone/subnetworks/subnetwork
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
#
# global/networks/default
@@ -846,7 +870,7 @@
"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 description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance resides.
- "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "tags": { # A set of instance tags. # A list of tags to apply 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",
],
@@ -867,15 +891,23 @@
# 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:
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
#
# 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:
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
#
- # 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.
+ # global/images/family/my-private-family
"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
@@ -933,11 +965,11 @@
"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", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
- # - zones/zone/subnetworks/subnetwork
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
#
# global/networks/default
@@ -989,7 +1021,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1004,7 +1036,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -1027,11 +1059,11 @@
The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
-For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
@@ -1046,7 +1078,7 @@
"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 description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance resides.
- "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "tags": { # A set of instance tags. # A list of tags to apply 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",
],
@@ -1067,15 +1099,23 @@
# 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:
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
#
# 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:
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
#
- # 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.
+ # global/images/family/my-private-family
"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
@@ -1133,11 +1173,11 @@
"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", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork
- # - zones/zone/subnetworks/subnetwork
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
#
# global/networks/default
@@ -1217,7 +1257,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1232,7 +1272,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -1278,7 +1318,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1293,7 +1333,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -1344,7 +1384,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1359,7 +1399,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -1417,7 +1457,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1432,7 +1472,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -1485,7 +1525,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1500,7 +1540,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -1556,7 +1596,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1571,7 +1611,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -1615,7 +1655,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1630,7 +1670,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
@@ -1674,7 +1714,7 @@
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
},
@@ -1689,7 +1729,7 @@
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},