Types overview

AWSV4Signature

Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.
Fields
accessKey

string

The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly

accessKeyId

string

The identifier of an access key used for s3 bucket authentication.

accessKeyVersion

string

The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.

originRegion

string

The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.

AcceleratorConfig

A specification of the type and number of accelerator cards attached to the instance.
Fields
acceleratorCount

integer (int32 format)

The number of the guest accelerator cards exposed to this instance.

acceleratorType

string

Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

AcceleratorType

Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated

object (DeprecationStatus)

[Output Only] The deprecation status associated with this accelerator type.

description

string

[Output Only] An optional textual description of the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types.

maximumCardsPerInstance

integer (int32 format)

[Output Only] Maximum number of accelerator cards allowed per instance.

name

string

[Output Only] Name of the resource.

selfLink

string

[Output Only] Server-defined, fully qualified URL for this resource.

zone

string

[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

AcceleratorTypeAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (AcceleratorTypesScopedList))

A list of AcceleratorTypesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AcceleratorTypeList

Contains a list of accelerator types.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (AcceleratorType)

A list of AcceleratorType resources.

kind

string

[Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AcceleratorTypesScopedList

(No description provided)
Fields
acceleratorTypes[]

object (AcceleratorType)

[Output Only] A list of accelerator types contained in this scope.

warning

object

[Output Only] An informational warning that appears when the accelerator types list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AccessConfig

An access configuration attached to an instance's network interface. Only one access config per instance is supported.
Fields
externalIpv6

string

Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.

externalIpv6PrefixLength

integer (int32 format)

Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.

kind

string

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

name

string

The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.

natIP

string

Applies to accessConfigs (IPv4) only. 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.

networkTier

enum

This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

Enum type. Can be one of the following:
FIXED_STANDARD Public internet quality with fixed bandwidth.
PREMIUM High quality, Google-grade network tier, support for all networking products.
STANDARD Public internet quality, only limited support for other networking products.
STANDARD_OVERRIDES_FIXED_STANDARD (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
publicPtrDomainName

string

The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.

setPublicPtr

boolean

Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.

type

enum

The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.

Enum type. Can be one of the following:
DIRECT_IPV6 (No description provided)
ONE_TO_ONE_NAT (No description provided)

Address

Represents an IP Address resource. Google Compute Engine has two IP Address resources: * Global (external and internal) * Regional (external and internal) For more information, see Reserving a static external IP address.
Fields
address

string

The static IP address represented by this resource.

addressType

enum

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.

Enum type. Can be one of the following:
EXTERNAL A publicly visible external IP address.
INTERNAL A private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.
UNSPECIFIED_TYPE (No description provided)
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this field when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

ipVersion

enum

The IP version that will be used by this address. Valid options are IPV4 or IPV6.

Enum type. Can be one of the following:
IPV4 (No description provided)
IPV6 (No description provided)
UNSPECIFIED_VERSION (No description provided)
ipv6EndpointType

enum

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.

Enum type. Can be one of the following:
NETLB Reserved IPv6 address can be used on network load balancer.
VM Reserved IPv6 address can be used on VM.
kind

string

[Output Only] Type of the resource. Always compute#address for addresses.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

network

string

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

networkTier

enum

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.

Enum type. Can be one of the following:
FIXED_STANDARD Public internet quality with fixed bandwidth.
PREMIUM High quality, Google-grade network tier, support for all networking products.
STANDARD Public internet quality, only limited support for other networking products.
STANDARD_OVERRIDES_FIXED_STANDARD (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
prefixLength

integer (int32 format)

The prefix length if the resource represents an IP range.

purpose

enum

The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.

Enum type. Can be one of the following:
DNS_RESOLVER DNS resolver address in the subnetwork.
GCE_ENDPOINT VM internal/alias IP, Internal LB service IP, etc.
IPSEC_INTERCONNECT A regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.
NAT_AUTO External IP automatically reserved for Cloud NAT.
PRIVATE_SERVICE_CONNECT A private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL
SERVERLESS A regional internal IP address range reserved for Serverless.
SHARED_LOADBALANCER_VIP A private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.
VPC_PEERING IP range for peer networks.
region

string

[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

selfLink

string

[Output Only] Server-defined URL for the resource.

status

enum

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

Enum type. Can be one of the following:
IN_USE Address is being used by another resource and is not available.
RESERVED Address is reserved and available to use.
RESERVING Address is being reserved.
subnetwork

string

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

users[]

string

[Output Only] The URLs of the resources that are using this address.

AddressAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (AddressesScopedList))

A list of AddressesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AddressList

Contains a list of addresses.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Address)

A list of Address resources.

kind

string

[Output Only] Type of resource. Always compute#addressList for lists of addresses.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AddressesScopedList

(No description provided)
Fields
addresses[]

object (Address)

[Output Only] A list of addresses contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of addresses when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AdvancedMachineFeatures

Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled).
Fields
enableNestedVirtualization

boolean

Whether to enable nested virtualization or not (default is false).

enableUefiNetworking

boolean

Whether to enable UEFI networking for instance creation.

threadsPerCore

integer (int32 format)

The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

visibleCoreCount

integer (int32 format)

The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

AliasIpRange

An alias IP range attached to an instance's network interface.
Fields
ipCidrRange

string

The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

subnetworkRangeName

string

The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

AllocationResourceStatus

[Output Only] Contains output only fields.
Fields
specificSkuAllocation

object (AllocationResourceStatusSpecificSKUAllocation)

Allocation Properties of this reservation.

AllocationResourceStatusSpecificSKUAllocation

Contains Properties set for the reservation.
Fields
sourceInstanceTemplateId

string

ID of the instance template used to populate reservation properties.

AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk

(No description provided)
Fields
diskSizeGb

string (int64 format)

Specifies the size of the disk in base-2 GB.

interface

enum

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

Enum type. Can be one of the following:
NVME (No description provided)
SCSI (No description provided)

AllocationSpecificSKUAllocationReservedInstanceProperties

Properties of the SKU instances being reserved. Next ID: 9
Fields
guestAccelerators[]

object (AcceleratorConfig)

Specifies accelerator type and count.

localSsds[]

object (AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk)

Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

locationHint

string

An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

machineType

string

Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

minCpuPlatform

string

Minimum cpu platform the reservation.

AllocationSpecificSKUReservation

This reservation type allows to pre allocate specific instance configuration. Next ID: 6
Fields
assuredCount

string (int64 format)

[Output Only] Indicates how many instances are actually usable currently.

count

string (int64 format)

Specifies the number of resources that are allocated.

inUseCount

string (int64 format)

[Output Only] Indicates how many instances are in use.

instanceProperties

object (AllocationSpecificSKUAllocationReservedInstanceProperties)

The instance properties for the reservation.

sourceInstanceTemplate

string

Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate

AttachedDisk

An instance-attached disk resource.
Fields
architecture

enum

[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.

Enum type. Can be one of the following:
ARCHITECTURE_UNSPECIFIED Default value indicating Architecture is not set.
ARM64 Machines with architecture ARM64
X86_64 Machines with architecture X86_64
autoDelete

boolean

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

boot

boolean

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

deviceName

string

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* 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-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

diskEncryptionKey

object (CustomerEncryptionKey)

Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

diskSizeGb

string (int64 format)

The size of the disk in GB.

forceAttach

boolean

[Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

guestOsFeatures[]

object (GuestOsFeature)

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

index

integer (int32 format)

[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

initializeParams

object (AttachedDiskInitializeParams)

[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.

interface

enum

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks.

Enum type. Can be one of the following:
NVME (No description provided)
SCSI (No description provided)
kind

string

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

licenses[]

string

[Output Only] Any valid publicly visible licenses.

mode

enum

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.

Enum type. Can be one of the following:
READ_ONLY Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.
READ_WRITE [Default] Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.
savedState

enum

For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

Enum type. Can be one of the following:
DISK_SAVED_STATE_UNSPECIFIED [Default] Disk state has not been preserved.
PRESERVED Disk state has been preserved.
shieldedInstanceInitialState

object (InitialStateConfig)

[Output Only] shielded vm initial state stored on disk

source

string

Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk.

type

enum

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Enum type. Can be one of the following:
PERSISTENT (No description provided)
SCRATCH (No description provided)

AttachedDiskInitializeParams

[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 field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Fields
architecture

enum

The architecture of the attached disk. Valid values are arm64 or x86_64.

Enum type. Can be one of the following:
ARCHITECTURE_UNSPECIFIED Default value indicating Architecture is not set.
ARM64 Machines with architecture ARM64
X86_64 Machines with architecture X86_64
description

string

An optional description. Provide this property when creating the disk.

diskName

string

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

diskSizeGb

string (int64 format)

Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

diskType

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 For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

labels

map (key: string, value: string)

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

licenses[]

string

A list of publicly visible licenses. Reserved for Google's use.

onUpdateAction

enum

Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Enum type. Can be one of the following:
RECREATE_DISK Always recreate the disk.
RECREATE_DISK_IF_SOURCE_CHANGED Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
USE_EXISTING_DISK Use the existing disk, this is the default behaviour.
provisionedIops

string (int64 format)

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

provisionedThroughput

string (int64 format)

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124.

replicaZones[]

string

Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.

resourceManagerTags

map (key: string, value: string)

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

resourcePolicies[]

string

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

sourceImage

string

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

sourceImageEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

sourceSnapshot

string

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

sourceSnapshotEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source snapshot.

AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Fields
auditLogConfigs[]

object (AuditLogConfig)

The configuration for logging of each type of permission.

exemptedMembers[]

string

This is deprecated and has no effect. Do not use.

service

string

Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.

AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Fields
exemptedMembers[]

string

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

ignoreChildExemptions

boolean

This is deprecated and has no effect. Do not use.

logType

enum

The log type that this config enables.

Enum type. Can be one of the following:
ADMIN_READ Admin reads. Example: CloudIAM getIamPolicy
DATA_READ Data reads. Example: CloudSQL Users list
DATA_WRITE Data writes. Example: CloudSQL Users create
LOG_TYPE_UNSPECIFIED Default case. Should never be this.

AuthorizationLoggingOptions

This is deprecated and has no effect. Do not use.
Fields
permissionType

enum

This is deprecated and has no effect. Do not use.

Enum type. Can be one of the following:
ADMIN_READ This is deprecated and has no effect. Do not use.
ADMIN_WRITE This is deprecated and has no effect. Do not use.
DATA_READ This is deprecated and has no effect. Do not use.
DATA_WRITE This is deprecated and has no effect. Do not use.
PERMISSION_TYPE_UNSPECIFIED This is deprecated and has no effect. Do not use.

Autoscaler

Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * Zonal * Regional Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource.
Fields
autoscalingPolicy

object (AutoscalingPolicy)

The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

recommendedSize

integer (int32 format)

[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.

region

string

[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).

scalingScheduleStatus

map (key: string, value: object (ScalingScheduleStatus))

[Output Only] Status information of existing scaling schedules.

selfLink

string

[Output Only] Server-defined URL for the resource.

status

enum

[Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.

Enum type. Can be one of the following:
ACTIVE Configuration is acknowledged to be effective
DELETING Configuration is being deleted
ERROR Configuration has errors. Actionable for users.
PENDING Autoscaler backend hasn't read new/updated configuration
statusDetails[]

object (AutoscalerStatusDetails)

[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

target

string

URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.

zone

string

[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

AutoscalerAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (AutoscalersScopedList))

A list of AutoscalersScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AutoscalerList

Contains a list of Autoscaler resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Autoscaler)

A list of Autoscaler resources.

kind

string

[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AutoscalerStatusDetails

(No description provided)
Fields
message

string

The status message.

type

enum

The type of error, warning, or notice returned. Current set of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only out" mode. The autoscaler can add instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.

Enum type. Can be one of the following:
ALL_INSTANCES_UNHEALTHY All instances in the instance group are unhealthy (not in RUNNING state).
BACKEND_SERVICE_DOES_NOT_EXIST There is no backend service attached to the instance group.
CAPPED_AT_MAX_NUM_REPLICAS Autoscaler recommends a size greater than maxNumReplicas.
CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE The custom metric samples are not exported often enough to be a credible base for autoscaling.
CUSTOM_METRIC_INVALID The custom metric that was specified does not exist or does not have the necessary labels.
MIN_EQUALS_MAX The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.
MISSING_CUSTOM_METRIC_DATA_POINTS The autoscaler did not receive any data from the custom metric configured for autoscaling.
MISSING_LOAD_BALANCING_DATA_POINTS The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.
MODE_OFF Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.
MODE_ONLY_SCALE_OUT Autoscaling is in the "Autoscale only scale out" mode. Instances in the group will be only added.
MODE_ONLY_UP Autoscaling is in the "Autoscale only out" mode. Instances in the group will be only added.
MORE_THAN_ONE_BACKEND_SERVICE The instance group cannot be autoscaled because it has more than one backend service attached to it.
NOT_ENOUGH_QUOTA_AVAILABLE There is insufficient quota for the necessary resources, such as CPU or number of instances.
REGION_RESOURCE_STOCKOUT Showed only for regional autoscalers: there is a resource stockout in the chosen region.
SCALING_TARGET_DOES_NOT_EXIST The target to be scaled does not exist.
SCHEDULED_INSTANCES_GREATER_THAN_AUTOSCALER_MAX For some scaling schedules minRequiredReplicas is greater than maxNumReplicas. Autoscaler always recommends at most maxNumReplicas instances.
SCHEDULED_INSTANCES_LESS_THAN_AUTOSCALER_MIN For some scaling schedules minRequiredReplicas is less than minNumReplicas. Autoscaler always recommends at least minNumReplicas instances.
UNKNOWN (No description provided)
UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.
ZONE_RESOURCE_STOCKOUT For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout.

AutoscalersScopedList

(No description provided)
Fields
autoscalers[]

object (Autoscaler)

[Output Only] A list of autoscalers contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

AutoscalingPolicy

Cloud Autoscaler policy.
Fields
coolDownPeriodSec

integer (int32 format)

The number of seconds that your application takes to initialize on a VM instance. This is referred to as the initialization period. Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process.

cpuUtilization

object (AutoscalingPolicyCpuUtilization)

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

customMetricUtilizations[]

object (AutoscalingPolicyCustomMetricUtilization)

Configuration parameters of autoscaling based on a custom metric.

loadBalancingUtilization

object (AutoscalingPolicyLoadBalancingUtilization)

Configuration parameters of autoscaling based on load balancer.

maxNumReplicas

integer (int32 format)

The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.

minNumReplicas

integer (int32 format)

The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.

mode

enum

Defines the operating mode for this policy. The following modes are available: - OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler"

Enum type. Can be one of the following:
OFF Do not automatically scale the MIG in or out. The recommended_size field contains the size of MIG that would be set if the actuation mode was enabled.
ON Automatically scale the MIG in and out according to the policy.
ONLY_SCALE_OUT Automatically create VMs according to the policy, but do not scale the MIG in.
ONLY_UP Automatically create VMs according to the policy, but do not scale the MIG in.
scaleInControl

object (AutoscalingPolicyScaleInControl)

(No description provided)

scalingSchedules

map (key: string, value: object (AutoscalingPolicyScalingSchedule))

Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.

AutoscalingPolicyCpuUtilization

CPU utilization policy.
Fields
predictiveMethod

enum

Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are: * NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics. * OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.

Enum type. Can be one of the following:
NONE No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics
OPTIMIZE_AVAILABILITY Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.
utilizationTarget

number (double format)

The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales in the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

AutoscalingPolicyCustomMetricUtilization

Custom utilization metric policy.
Fields
filter

string

A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: - You can only use the AND operator for joining selectors. - You can only use direct equality comparison operator (=) without any functions for each selector. - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. Try to provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

metric

string

The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE.

singleInstanceAssignment

number (double format)

If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler keeps the number of instances proportional to the value of this metric. The metric itself does not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.

utilizationTarget

number (double format)

The target value of the metric that autoscaler maintains. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is https://www.googleapis.com/compute/v1/instance/network/received_bytes_count. The autoscaler works to keep this value constant for each of the instances.

utilizationTargetType

enum

Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Enum type. Can be one of the following:
DELTA_PER_MINUTE Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per minute.
DELTA_PER_SECOND Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per second.
GAUGE Sets the utilization target value for a gauge metric. The autoscaler will collect the average utilization of the virtual machines from the last couple of minutes, and compare the value to the utilization target value to perform autoscaling.

AutoscalingPolicyLoadBalancingUtilization

Configuration parameters of autoscaling based on load balancing.
Fields
utilizationTarget

number (double format)

Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that the autoscaler maintains. Must be a positive float value. If not defined, the default is 0.8.

AutoscalingPolicyScaleInControl

Configuration that allows for slower scale in so that even if Autoscaler recommends an abrupt scale in of a MIG, it will be throttled as specified by the parameters below.
Fields
maxScaledInReplicas

object (FixedOrPercent)

Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.

timeWindowSec

integer (int32 format)

How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.

AutoscalingPolicyScalingSchedule

Scaling based on user-defined schedule. The message describes a single scaling schedule. A scaling schedule changes the minimum number of VM instances an autoscaler can recommend, which can trigger scaling out.
Fields
description

string

A description of a scaling schedule.

disabled

boolean

A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default.

durationSec

integer (int32 format)

The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required.

minRequiredReplicas

integer (int32 format)

The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.

schedule

string

The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to time_zone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving.

timeZone

string

The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty.

Backend

Message containing information of one individual backend.
Fields
balancingMode

enum

Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.

Enum type. Can be one of the following:
CONNECTION Balance based on the number of simultaneous connections.
RATE Balance based on requests per second (RPS).
UTILIZATION Balance based on the backend utilization.
capacityScaler

number (float format)

A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.

description

string

An optional description of this resource. Provide this property when you create the resource.

failover

boolean

This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

group

string

The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

maxConnections

integer (int32 format)

Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.

maxConnectionsPerEndpoint

integer (int32 format)

Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.

maxConnectionsPerInstance

integer (int32 format)

Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.

maxRate

integer (int32 format)

Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.

maxRatePerEndpoint

number (float format)

Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.

maxRatePerInstance

number (float format)

Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.

maxUtilization

number (float format)

Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.

BackendBucket

Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.
Fields
bucketName

string

Cloud Storage bucket name.

cdnPolicy

object (BackendBucketCdnPolicy)

Cloud CDN configuration for this BackendBucket.

compressionMode

enum

Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.

Enum type. Can be one of the following:
AUTOMATIC Automatically uses the best compression based on the Accept-Encoding header sent by the client.
DISABLED Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

customResponseHeaders[]

string

Headers that the Application Load Balancer should add to proxied responses.

description

string

An optional textual description of the resource; provided by the client when the resource is created.

edgeSecurityPolicy

string

[Output Only] The resource URL for the edge security policy associated with this backend bucket.

enableCdn

boolean

If true, enable Cloud CDN for this BackendBucket.

id

string (uint64 format)

[Output Only] Unique identifier for the resource; defined by the server.

kind

string

Type of the resource.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

selfLink

string

[Output Only] Server-defined URL for the resource.

BackendBucketCdnPolicy

Message containing Cloud CDN configuration for a backend bucket.
Fields
bypassCacheOnRequestHeaders[]

object (BackendBucketCdnPolicyBypassCacheOnRequestHeader)

Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.

cacheKeyPolicy

object (BackendBucketCdnPolicyCacheKeyPolicy)

The CacheKeyPolicy for this CdnPolicy.

cacheMode

enum

Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

Enum type. Can be one of the following:
CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
INVALID_CACHE_MODE (No description provided)
USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.
clientTtl

integer (int32 format)

Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).

defaultTtl

integer (int32 format)

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

maxTtl

integer (int32 format)

Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

negativeCaching

boolean

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.

negativeCachingPolicy[]

object (BackendBucketCdnPolicyNegativeCachingPolicy)

Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

requestCoalescing

boolean

If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

serveWhileStale

integer (int32 format)

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

signedUrlCacheMaxAgeSec

string (int64 format)

Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

signedUrlKeyNames[]

string

[Output Only] Names of the keys for signing request URLs.

BackendBucketCdnPolicyBypassCacheOnRequestHeader

Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
Fields
headerName

string

The header field name to match on when bypassing cache. Values are case-insensitive.

BackendBucketCdnPolicyCacheKeyPolicy

Message containing what to include in the cache key for a request for Cloud CDN.
Fields
includeHttpHeaders[]

string

Allows HTTP request headers (by name) to be used in the cache key.

queryStringWhitelist[]

string

Names of query string parameters to include in cache keys. Default parameters are always included. '&' and '=' will be percent encoded and not treated as delimiters.

BackendBucketCdnPolicyNegativeCachingPolicy

Specify CDN TTLs for response error codes.
Fields
code

integer (int32 format)

The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.

ttl

integer (int32 format)

The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

BackendBucketList

Contains a list of BackendBucket resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (BackendBucket)

A list of BackendBucket resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

BackendService

Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * Global * Regional For more information, see Backend Services.
Fields
affinityCookieTtlSec

integer (int32 format)

Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

backends[]

object (Backend)

The list of backends that serve this BackendService.

cdnPolicy

object (BackendServiceCdnPolicy)

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

circuitBreakers

object (CircuitBreakers)

(No description provided)

compressionMode

enum

Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.

Enum type. Can be one of the following:
AUTOMATIC Automatically uses the best compression based on the Accept-Encoding header sent by the client.
DISABLED Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.
connectionDraining

object (ConnectionDraining)

(No description provided)

connectionTrackingPolicy

object (BackendServiceConnectionTrackingPolicy)

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

consistentHash

object (ConsistentHashLoadBalancerSettings)

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

customRequestHeaders[]

string

Headers that the load balancer adds to proxied requests. See Creating custom headers.

customResponseHeaders[]

string

Headers that the load balancer adds to proxied responses. See Creating custom headers.

description

string

An optional description of this resource. Provide this property when you create the resource.

edgeSecurityPolicy

string

[Output Only] The resource URL for the edge security policy associated with this backend service.

enableCDN

boolean

If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.

failoverPolicy

object (BackendServiceFailoverPolicy)

Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.

healthChecks[]

string

The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.

iap

object (BackendServiceIAP)

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of resource. Always compute#backendService for backend services.

loadBalancingScheme

enum

Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.

Enum type. Can be one of the following:
EXTERNAL Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing
EXTERNAL_MANAGED Signifies that this will be used for External Managed HTTP(S) Load Balancing.
INTERNAL Signifies that this will be used for Internal TCP/UDP Load Balancing.
INTERNAL_MANAGED Signifies that this will be used for Internal HTTP(S) Load Balancing.
INTERNAL_SELF_MANAGED Signifies that this will be used by Traffic Director.
INVALID_LOAD_BALANCING_SCHEME (No description provided)
localityLbPolicies[]

object (BackendServiceLocalityLoadBalancingPolicyConfig)

A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.

localityLbPolicy

enum

The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Enum type. Can be one of the following:
INVALID_LB_POLICY (No description provided)
LEAST_REQUEST An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
MAGLEV This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
ORIGINAL_DESTINATION Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
RANDOM The load balancer selects a random healthy host.
RING_HASH The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
ROUND_ROBIN This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
WEIGHTED_MAGLEV Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.
logConfig

object (BackendServiceLogConfig)

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

maxStreamDuration

object (Duration)

Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.

metadatas

map (key: string, value: string)

Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

string

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.

outlierDetection

object (OutlierDetection)

Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

port

integer (int32 format)

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.

portName

string

A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.

protocol

enum

The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.

Enum type. Can be one of the following:
GRPC gRPC (available for Traffic Director).
HTTP (No description provided)
HTTP2 HTTP/2 with SSL.
HTTPS (No description provided)
SSL TCP proxying with SSL.
TCP TCP proxying or TCP pass-through.
UDP UDP.
UNSPECIFIED If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.
region

string

[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

securityPolicy

string

[Output Only] The resource URL for the security policy associated with this backend service.

securitySettings

object (SecuritySettings)

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

selfLink

string

[Output Only] Server-defined URL for the resource.

serviceBindings[]

string

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

sessionAffinity

enum

Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.

Enum type. Can be one of the following:
CLIENT_IP 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.
CLIENT_IP_NO_DESTINATION 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.
CLIENT_IP_PORT_PROTO 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
CLIENT_IP_PROTO 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
GENERATED_COOKIE Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
HEADER_FIELD The hash is based on a user specified header field.
HTTP_COOKIE The hash is based on a user provided cookie.
NONE No session affinity. Connections from the same client IP may go to any instance in the pool.
subsetting

object (Subsetting)

(No description provided)

timeoutSec

integer (int32 format)

The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.

BackendServiceAggregatedList

Contains a list of BackendServicesScopedList.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (BackendServicesScopedList))

A list of BackendServicesScopedList resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

BackendServiceCdnPolicy

Message containing Cloud CDN configuration for a backend service.
Fields
bypassCacheOnRequestHeaders[]

object (BackendServiceCdnPolicyBypassCacheOnRequestHeader)

Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.

cacheKeyPolicy

object (CacheKeyPolicy)

The CacheKeyPolicy for this CdnPolicy.

cacheMode

enum

Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

Enum type. Can be one of the following:
CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
INVALID_CACHE_MODE (No description provided)
USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.
clientTtl

integer (int32 format)

Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).

defaultTtl

integer (int32 format)

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

maxTtl

integer (int32 format)

Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

negativeCaching

boolean

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.

negativeCachingPolicy[]

object (BackendServiceCdnPolicyNegativeCachingPolicy)

Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

requestCoalescing

boolean

If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

serveWhileStale

integer (int32 format)

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

signedUrlCacheMaxAgeSec

string (int64 format)

Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

signedUrlKeyNames[]

string

[Output Only] Names of the keys for signing request URLs.

BackendServiceCdnPolicyBypassCacheOnRequestHeader

Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
Fields
headerName

string

The header field name to match on when bypassing cache. Values are case-insensitive.

BackendServiceCdnPolicyNegativeCachingPolicy

Specify CDN TTLs for response error codes.
Fields
code

integer (int32 format)

The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.

ttl

integer (int32 format)

The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

BackendServiceConnectionTrackingPolicy

Connection Tracking configuration for this BackendService.
Fields
connectionPersistenceOnUnhealthyBackends

enum

Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.

Enum type. Can be one of the following:
ALWAYS_PERSIST (No description provided)
DEFAULT_FOR_PROTOCOL (No description provided)
NEVER_PERSIST (No description provided)
enableStrongAffinity

boolean

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

idleTimeoutSec

integer (int32 format)

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.

trackingMode

enum

Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.

Enum type. Can be one of the following:
INVALID_TRACKING_MODE (No description provided)
PER_CONNECTION (No description provided)
PER_SESSION (No description provided)

BackendServiceFailoverPolicy

For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).
Fields
disableConnectionDrainOnFailover

boolean

This can be set to true only if the protocol is TCP. The default is false.

dropTrafficIfUnhealthy

boolean

If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.

failoverRatio

number (float format)

The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.

BackendServiceGroupHealth

(No description provided)
Fields
annotations

map (key: string, value: string)

Metadata defined as annotations on the network endpoint group.

healthStatus[]

object (HealthStatus)

Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.

kind

string

[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.

BackendServiceIAP

Identity-Aware Proxy
Fields
enabled

boolean

Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.

oauth2ClientId

string

OAuth2 client ID to use for the authentication flow.

oauth2ClientSecret

string

OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly

oauth2ClientSecretSha256

string

[Output Only] SHA256 hash value for the field oauth2_client_secret above.

BackendServiceList

Contains a list of BackendService resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (BackendService)

A list of BackendService resources.

kind

string

[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

BackendServiceLocalityLoadBalancingPolicyConfig

Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user.
Fields
customPolicy

object (BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy)

(No description provided)

policy

object (BackendServiceLocalityLoadBalancingPolicyConfigPolicy)

(No description provided)

BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy

The configuration for a custom policy implemented by the user and deployed with the client.
Fields
data

string

An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.

name

string

Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.

BackendServiceLocalityLoadBalancingPolicyConfigPolicy

The configuration for a built-in load balancing policy.
Fields
name

enum

The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.

Enum type. Can be one of the following:
INVALID_LB_POLICY (No description provided)
LEAST_REQUEST An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
MAGLEV This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
ORIGINAL_DESTINATION Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
RANDOM The load balancer selects a random healthy host.
RING_HASH The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
ROUND_ROBIN This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
WEIGHTED_MAGLEV Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.

BackendServiceLogConfig

The available logging options for the load balancer traffic served by this backend service.
Fields
enable

boolean

Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.

optionalFields[]

string

This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace

optionalMode

enum

This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.

Enum type. Can be one of the following:
CUSTOM A subset of optional fields.
EXCLUDE_ALL_OPTIONAL None optional fields.
INCLUDE_ALL_OPTIONAL All optional fields.
sampleRate

number (float format)

This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

BackendServiceReference

(No description provided)
Fields
backendService

string

(No description provided)

BackendServicesScopedList

(No description provided)
Fields
backendServices[]

object (BackendService)

A list of BackendServices contained in this scope.

warning

object

Informational warning which replaces the list of backend services when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

BfdPacket

(No description provided)
Fields
authenticationPresent

boolean

The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880

controlPlaneIndependent

boolean

The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880

demand

boolean

The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880

diagnostic

enum

The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880

Enum type. Can be one of the following:
ADMINISTRATIVELY_DOWN (No description provided)
CONCATENATED_PATH_DOWN (No description provided)
CONTROL_DETECTION_TIME_EXPIRED (No description provided)
DIAGNOSTIC_UNSPECIFIED (No description provided)
ECHO_FUNCTION_FAILED (No description provided)
FORWARDING_PLANE_RESET (No description provided)
NEIGHBOR_SIGNALED_SESSION_DOWN (No description provided)
NO_DIAGNOSTIC (No description provided)
PATH_DOWN (No description provided)
REVERSE_CONCATENATED_PATH_DOWN (No description provided)
final

boolean

The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880

length

integer (uint32 format)

The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880

minEchoRxIntervalMs

integer (uint32 format)

The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

minRxIntervalMs

integer (uint32 format)

The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

minTxIntervalMs

integer (uint32 format)

The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

multiplier

integer (uint32 format)

The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880

multipoint

boolean

The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880

myDiscriminator

integer (uint32 format)

The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

poll

boolean

The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880

state

enum

The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880

Enum type. Can be one of the following:
ADMIN_DOWN (No description provided)
DOWN (No description provided)
INIT (No description provided)
STATE_UNSPECIFIED (No description provided)
UP (No description provided)
version

integer (uint32 format)

The version number of the BFD protocol, as specified in section 4.1 of RFC5880.

yourDiscriminator

integer (uint32 format)

The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

BfdStatus

Next free: 15
Fields
bfdSessionInitializationMode

enum

The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer.

Enum type. Can be one of the following:
ACTIVE (No description provided)
DISABLED (No description provided)
PASSIVE (No description provided)
configUpdateTimestampMicros

string (int64 format)

Unix timestamp of the most recent config update.

controlPacketCounts

object (BfdStatusPacketCounts)

Control packet counts for the current BFD session.

controlPacketIntervals[]

object (PacketIntervals)

Inter-packet time interval statistics for control packets.

localDiagnostic

enum

The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880

Enum type. Can be one of the following:
ADMINISTRATIVELY_DOWN (No description provided)
CONCATENATED_PATH_DOWN (No description provided)
CONTROL_DETECTION_TIME_EXPIRED (No description provided)
DIAGNOSTIC_UNSPECIFIED (No description provided)
ECHO_FUNCTION_FAILED (No description provided)
FORWARDING_PLANE_RESET (No description provided)
NEIGHBOR_SIGNALED_SESSION_DOWN (No description provided)
NO_DIAGNOSTIC (No description provided)
PATH_DOWN (No description provided)
REVERSE_CONCATENATED_PATH_DOWN (No description provided)
localState

enum

The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880

Enum type. Can be one of the following:
ADMIN_DOWN (No description provided)
DOWN (No description provided)
INIT (No description provided)
STATE_UNSPECIFIED (No description provided)
UP (No description provided)
negotiatedLocalControlTxIntervalMs

integer (uint32 format)

Negotiated transmit interval for control packets.

rxPacket

object (BfdPacket)

The most recent Rx control packet for this BFD session.

txPacket

object (BfdPacket)

The most recent Tx control packet for this BFD session.

uptimeMs

string (int64 format)

Session uptime in milliseconds. Value will be 0 if session is not up.

BfdStatusPacketCounts

(No description provided)
Fields
numRx

integer (uint32 format)

Number of packets received since the beginning of the current BFD session.

numRxRejected

integer (uint32 format)

Number of packets received that were rejected because of errors since the beginning of the current BFD session.

numRxSuccessful

integer (uint32 format)

Number of packets received that were successfully processed since the beginning of the current BFD session.

numTx

integer (uint32 format)

Number of packets transmitted since the beginning of the current BFD session.

Binding

Associates members, or principals, with a role.
Fields
bindingId

string

This is deprecated and has no effect. Do not use.

condition

object (Expr)

The condition that is associated with this binding. If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the IAM documentation.

members[]

string

Specifies the principals requesting access for a Google Cloud resource. members can have the following values: * allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. * allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . * serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. * serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account. For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. * group:{emailid}: An email address that represents a Google group. For example, admins@example.com. * domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. * deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. * deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.

role

string

Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.

BulkInsertDiskResource

A transient resource used in compute.disks.bulkInsert and compute.regionDisks.bulkInsert. It is only used to process requests and is not persisted.
Fields
sourceConsistencyGroupPolicy

string

The URL of the DiskConsistencyGroupPolicy for the group of disks to clone. This may be a full or partial URL, such as: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy

BulkInsertInstanceResource

A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert . This resource is not persisted anywhere, it is used only for processing the requests.
Fields
count

string (int64 format)

The maximum number of instances to create.

instanceProperties

object (InstanceProperties)

The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

instanceProperties.metadata.items.key

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.

instanceProperties.metadata.items.value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

locationPolicy

object (LocationPolicy)

Policy for chosing target zone. For more information, see Create VMs in bulk .

minCount

string (int64 format)

The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.

namePattern

string

The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.

perInstanceProperties

map (key: string, value: object (BulkInsertInstanceResourcePerInstanceProperties))

Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used.

sourceInstanceTemplate

string

Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional.

BulkInsertInstanceResourcePerInstanceProperties

Per-instance properties to be set on individual instances. To be extended in the future.
Fields
hostname

string

Specifies the hostname of the instance. More details in: https://cloud.google.com/compute/docs/instances/custom-hostname-vm#naming_convention

name

string

This field is only temporary. It will be removed. Do not use it.

CacheInvalidationRule

(No description provided)
Fields
host

string

If set, this invalidation rule will only apply to requests with a Host header matching host.

path

string

(No description provided)

CacheKeyPolicy

Message containing what to include in the cache key for a request for Cloud CDN.
Fields
includeHost

boolean

If true, requests to different hosts will be cached separately.

includeHttpHeaders[]

string

Allows HTTP request headers (by name) to be used in the cache key.

includeNamedCookies[]

string

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

includeProtocol

boolean

If true, http and https requests will be cached separately.

includeQueryString

boolean

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

queryStringBlacklist[]

string

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

queryStringWhitelist[]

string

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

CircuitBreakers

Settings controlling the volume of requests, connections and retries to this backend service.
Fields
maxConnections

integer (int32 format)

The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

maxPendingRequests

integer (int32 format)

The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

maxRequests

integer (int32 format)

The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

maxRequestsPerConnection

integer (int32 format)

Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

maxRetries

integer (int32 format)

The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Commitment

Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.
Fields
autoRenew

boolean

Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

category

enum

The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.

Enum type. Can be one of the following:
CATEGORY_UNSPECIFIED (No description provided)
LICENSE (No description provided)
MACHINE (No description provided)
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

endTimestamp

string

[Output Only] Commitment end time in RFC3339 text format.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#commitment for commitments.

licenseResource

object (LicenseResourceCommitment)

The license specification required as part of a license commitment.

mergeSourceCommitments[]

string

List of source commitments to be merged into a new commitment.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

plan

enum

The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).

Enum type. Can be one of the following:
INVALID (No description provided)
THIRTY_SIX_MONTH (No description provided)
TWELVE_MONTH (No description provided)
region

string

[Output Only] URL of the region where this commitment may be used.

reservations[]

object (Reservation)

List of reservations in this commitment.

resources[]

object (ResourceCommitment)

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

selfLink

string

[Output Only] Server-defined URL for the resource.

splitSourceCommitment

string

Source commitment to be split into a new commitment.

startTimestamp

string

[Output Only] Commitment start time in RFC3339 text format.

status

enum

[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.

Enum type. Can be one of the following:
ACTIVE (No description provided)
CANCELLED Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
CREATING (No description provided)
EXPIRED (No description provided)
NOT_YET_ACTIVE (No description provided)
statusMessage

string

[Output Only] An optional, human-readable explanation of the status.

type

enum

The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

Enum type. Can be one of the following:
ACCELERATOR_OPTIMIZED (No description provided)
ACCELERATOR_OPTIMIZED_A3 (No description provided)
COMPUTE_OPTIMIZED (No description provided)
COMPUTE_OPTIMIZED_C2D (No description provided)
COMPUTE_OPTIMIZED_C3 (No description provided)
COMPUTE_OPTIMIZED_H3 (No description provided)
GENERAL_PURPOSE (No description provided)
GENERAL_PURPOSE_E2 (No description provided)
GENERAL_PURPOSE_N2 (No description provided)
GENERAL_PURPOSE_N2D (No description provided)
GENERAL_PURPOSE_T2D (No description provided)
GRAPHICS_OPTIMIZED (No description provided)
MEMORY_OPTIMIZED (No description provided)
MEMORY_OPTIMIZED_M3 (No description provided)
TYPE_UNSPECIFIED (No description provided)

CommitmentAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (CommitmentsScopedList))

A list of CommitmentsScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

CommitmentList

Contains a list of Commitment resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Commitment)

A list of Commitment resources.

kind

string

[Output Only] Type of resource. Always compute#commitmentList for lists of commitments.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

CommitmentsScopedList

(No description provided)
Fields
commitments[]

object (Commitment)

[Output Only] A list of commitments contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of commitments when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

Condition

This is deprecated and has no effect. Do not use.
Fields
iam

enum

This is deprecated and has no effect. Do not use.

Enum type. Can be one of the following:
APPROVER This is deprecated and has no effect. Do not use.
ATTRIBUTION This is deprecated and has no effect. Do not use.
AUTHORITY This is deprecated and has no effect. Do not use.
CREDENTIALS_TYPE This is deprecated and has no effect. Do not use.
CREDS_ASSERTION This is deprecated and has no effect. Do not use.
JUSTIFICATION_TYPE This is deprecated and has no effect. Do not use.
NO_ATTR This is deprecated and has no effect. Do not use.
SECURITY_REALM This is deprecated and has no effect. Do not use.
op

enum

This is deprecated and has no effect. Do not use.

Enum type. Can be one of the following:
DISCHARGED This is deprecated and has no effect. Do not use.
EQUALS This is deprecated and has no effect. Do not use.
IN This is deprecated and has no effect. Do not use.
NOT_EQUALS This is deprecated and has no effect. Do not use.
NOT_IN This is deprecated and has no effect. Do not use.
NO_OP This is deprecated and has no effect. Do not use.
svc

string

This is deprecated and has no effect. Do not use.

sys

enum

This is deprecated and has no effect. Do not use.

Enum type. Can be one of the following:
IP This is deprecated and has no effect. Do not use.
NAME This is deprecated and has no effect. Do not use.
NO_ATTR This is deprecated and has no effect. Do not use.
REGION This is deprecated and has no effect. Do not use.
SERVICE This is deprecated and has no effect. Do not use.
values[]

string

This is deprecated and has no effect. Do not use.

ConfidentialInstanceConfig

A set of Confidential Instance options.
Fields
enableConfidentialCompute

boolean

Defines whether the instance should have confidential compute enabled.

ConnectionDraining

Message containing connection draining configuration.
Fields
drainingTimeoutSec

integer (int32 format)

Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.

ConsistentHashLoadBalancerSettings

This message defines settings for a consistent hash style load balancer.
Fields
httpCookie

object (ConsistentHashLoadBalancerSettingsHttpCookie)

Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

httpHeaderName

string

The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

minimumRingSize

string (int64 format)

The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

ConsistentHashLoadBalancerSettingsHttpCookie

The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.
Fields
name

string

Name of the cookie.

path

string

Path to set for the cookie.

ttl

object (Duration)

Lifetime of the cookie.

CorsPolicy

The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard.
Fields
allowCredentials

boolean

In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false.

allowHeaders[]

string

Specifies the content for the Access-Control-Allow-Headers header.

allowMethods[]

string

Specifies the content for the Access-Control-Allow-Methods header.

allowOriginRegexes[]

string

Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

allowOrigins[]

string

Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

disabled

boolean

If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

exposeHeaders[]

string

Specifies the content for the Access-Control-Expose-Headers header.

maxAge

integer (int32 format)

Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.

CustomerEncryptionKey

(No description provided)
Fields
kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1

kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

CustomerEncryptionKeyProtectedDisk

(No description provided)
Fields
diskEncryptionKey

object (CustomerEncryptionKey)

Decrypts data associated with the disk with a customer-supplied encryption key.

source

string

Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. For example: "source": "/compute/v1/projects/project_id/zones/zone/disks/ disk_name

DeprecationStatus

Deprecation status for a public resource.
Fields
deleted

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

obsolete

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

replacement

string

The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

state

enum

The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

Enum type. Can be one of the following:
ACTIVE (No description provided)
DELETED (No description provided)
DEPRECATED (No description provided)
OBSOLETE (No description provided)

Disk

Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * Zonal * Regional Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.
Fields
architecture

enum

The architecture of the disk. Valid values are ARM64 or X86_64.

Enum type. Can be one of the following:
ARCHITECTURE_UNSPECIFIED Default value indicating Architecture is not set.
ARM64 Machines with architecture ARM64
X86_64 Machines with architecture X86_64
asyncPrimaryDisk

object (DiskAsyncReplication)

Disk asynchronously replicated into this disk.

asyncSecondaryDisks

map (key: string, value: object (DiskAsyncReplicationList))

[Output Only] A list of disks this disk is asynchronously replicated to.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

diskEncryptionKey

object (CustomerEncryptionKey)

Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.

guestOsFeatures[]

object (GuestOsFeature)

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#disk for disks.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.

labels

map (key: string, value: string)

Labels to apply to this disk. These can be later modified by the setLabels method.

lastAttachTimestamp

string

[Output Only] Last attach timestamp in RFC3339 text format.

lastDetachTimestamp

string

[Output Only] Last detach timestamp in RFC3339 text format.

licenseCodes[]

string (int64 format)

Integer license codes indicating which licenses are attached to this disk.

licenses[]

string

A list of publicly visible licenses. Reserved for Google's use.

locationHint

string

An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

options

string

Internal use only.

params

object (DiskParams)

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

physicalBlockSizeBytes

string (int64 format)

Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

provisionedIops

string (int64 format)

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

provisionedThroughput

string (int64 format)

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124.

region

string

[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

replicaZones[]

string

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

resourcePolicies[]

string

Resource policies applied to this disk for automatic snapshot creations.

resourceStatus

object (DiskResourceStatus)

[Output Only] Status information for the disk resource.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

selfLink

string

[Output Only] Server-defined fully-qualified URL for this resource.

sizeGb

string (int64 format)

Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive.

sourceConsistencyGroupPolicy

string

[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

sourceConsistencyGroupPolicyId

string

[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

sourceDisk

string

The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

sourceDiskId

string

[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

sourceImage

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-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

sourceImageEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

sourceImageId

string

[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

sourceSnapshot

string

The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

sourceSnapshotEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

sourceSnapshotId

string

[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

sourceStorageObject

string

The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

status

enum

[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting.

Enum type. Can be one of the following:
CREATING Disk is provisioning
DELETING Disk is deleting.
FAILED Disk creation failed.
READY Disk is ready for use.
RESTORING Source data is being copied into the disk.
type

string

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.

users[]

string

[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

zone

string

[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

DiskAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (DisksScopedList))

A list of DisksScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

DiskAsyncReplication

(No description provided)
Fields
consistencyGroupPolicy

string

[Output Only] URL of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.

consistencyGroupPolicyId

string

[Output Only] ID of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.

disk

string

The other disk asynchronously replicated to or from the current disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk

diskId

string

[Output Only] The unique ID of the other disk asynchronously replicated to or from the current disk. This value identifies the exact disk that was used to create this replication. For example, if you started replicating the persistent disk from a disk that was later deleted and recreated under the same name, the disk ID would identify the exact version of the disk that was used.

DiskAsyncReplicationList

(No description provided)
Fields
asyncReplicationDisk

object (DiskAsyncReplication)

(No description provided)

DiskInstantiationConfig

A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.
Fields
autoDelete

boolean

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

customImage

string

The custom source image to be used to restore this disk when instantiating this instance template.

deviceName

string

Specifies the device name of the disk to which the configurations apply to.

instantiateFrom

enum

Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.

Enum type. Can be one of the following:
ATTACH_READ_ONLY Attach the existing disk in read-only mode. The request will fail if the disk was attached in read-write mode on the source instance. Applicable to: read-only disks.
BLANK Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.
CUSTOM_IMAGE Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.
DEFAULT Use the default instantiation option for the corresponding type of disk. For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.
DO_NOT_INCLUDE Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.
SOURCE_IMAGE Use the same source image used for creation of the source instance's corresponding disk. The request will fail if the source VM's disk was created from a snapshot. Applicable to: boot disk, additional read-write disks.
SOURCE_IMAGE_FAMILY Use the same source image family used for creation of the source instance's corresponding disk. The request will fail if the source image of the source disk does not belong to any image family. Applicable to: boot disk, additional read-write disks.

DiskList

A list of Disk resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Disk)

A list of Disk resources.

kind

string

[Output Only] Type of resource. Always compute#diskList for lists of disks.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

DiskMoveRequest

(No description provided)
Fields
destinationZone

string

The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone

targetDisk

string

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

DiskParams

Additional disk params.
Fields
resourceManagerTags

map (key: string, value: string)

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

DiskResourceStatus

(No description provided)
Fields
asyncPrimaryDisk

object (DiskResourceStatusAsyncReplicationStatus)

(No description provided)

asyncSecondaryDisks

map (key: string, value: object (DiskResourceStatusAsyncReplicationStatus))

Key: disk, value: AsyncReplicationStatus message

DiskResourceStatusAsyncReplicationStatus

(No description provided)
Fields
state

enum

(No description provided)

Enum type. Can be one of the following:
ACTIVE Replication is active.
CREATED Secondary disk is created and is waiting for replication to start.
STARTING Replication is starting.
STATE_UNSPECIFIED (No description provided)
STOPPED Replication is stopped.
STOPPING Replication is stopping.

DiskType

Represents a Disk Type resource. Google Compute Engine has two Disk Type resources: * Regional * Zonal You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

defaultDiskSizeGb

string (int64 format)

[Output Only] Server-defined default disk size in GB.

deprecated

object (DeprecationStatus)

[Output Only] The deprecation status associated with this disk type.

description

string

[Output Only] An optional description of this resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#diskType for disk types.

name

string

[Output Only] Name of the resource.

region

string

[Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

validDiskSize

string

[Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".

zone

string

[Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

DiskTypeAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (DiskTypesScopedList))

A list of DiskTypesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#diskTypeAggregatedList.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

DiskTypeList

Contains a list of disk types.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (DiskType)

A list of DiskType resources.

kind

string

[Output Only] Type of resource. Always compute#diskTypeList for disk types.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

DiskTypesScopedList

(No description provided)
Fields
diskTypes[]

object (DiskType)

[Output Only] A list of disk types contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of disk types when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

DisksAddResourcePoliciesRequest

(No description provided)
Fields
resourcePolicies[]

string

Full or relative path to the resource policy to be added to this disk. You can only specify one resource policy.

DisksRemoveResourcePoliciesRequest

(No description provided)
Fields
resourcePolicies[]

string

Resource policies to be removed from this disk.

DisksResizeRequest

(No description provided)
Fields
sizeGb

string (int64 format)

The new size of the persistent disk, which is specified in GB.

DisksScopedList

(No description provided)
Fields
disks[]

object (Disk)

[Output Only] A list of disks contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of disks when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

DisksStartAsyncReplicationRequest

(No description provided)
Fields
asyncSecondaryDisk

string

The secondary disk to start asynchronous replication to. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

DisksStopGroupAsyncReplicationResource

A transient resource used in compute.disks.stopGroupAsyncReplication and compute.regionDisks.stopGroupAsyncReplication. It is only used to process requests and is not persisted.
Fields
resourcePolicy

string

The URL of the DiskConsistencyGroupPolicy for the group of disks to stop. This may be a full or partial URL, such as: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy

DisplayDevice

A set of Display Device options
Fields
enableDisplay

boolean

Defines whether the instance has Display enabled.

DistributionPolicy

(No description provided)
Fields
targetShape

enum

The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).

Enum type. Can be one of the following:
ANY The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.
ANY_SINGLE_ZONE The group creates all VM instances within a single zone. The zone is selected based on the present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads with heavy interprocess communication.
BALANCED The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.
EVEN The group schedules VM instance creation and deletion to achieve and maintain an even number of managed instances across the selected zones. The distribution is even when the number of managed instances does not differ by more than 1 between any two zones. Recommended for highly available serving workloads.
zones[]

object (DistributionPolicyZoneConfiguration)

Zones where the regional managed instance group will create and manage its instances.

DistributionPolicyZoneConfiguration

(No description provided)
Fields
zone

string

The URL of the zone. The zone must exist in the region where the managed instance group is located.

Duration

A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years.
Fields
nanos

integer (int32 format)

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds

string (int64 format)

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

ErrorInfo

Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
Fields
domain

string

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

metadatas

map (key: string, value: string)

Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

reason

string

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of A-Z+[A-Z0-9], which represents UPPER_SNAKE_CASE.

ExchangedPeeringRoute

(No description provided)
Fields
destRange

string

The destination range of the route.

imported

boolean

True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict.

nextHopRegion

string

The region of peering route next hop, only applies to dynamic routes.

priority

integer (uint32 format)

The priority of the peering route.

type

enum

The type of the peering route.

Enum type. Can be one of the following:
DYNAMIC_PEERING_ROUTE For routes exported from local network.
STATIC_PEERING_ROUTE The peering route.
SUBNET_PEERING_ROUTE The peering route corresponding to subnetwork range.

ExchangedPeeringRoutesList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (ExchangedPeeringRoute)

A list of ExchangedPeeringRoute resources.

kind

string

[Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Fields
description

string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression

string

Textual representation of an expression in Common Expression Language syntax.

location

string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

title

string

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

ExternalVpnGateway

Represents an external VPN gateway. External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

interfaces[]

object (ExternalVpnGatewayInterface)

A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.

kind

string

[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

redundancyType

enum

Indicates the user-supplied redundancy type of this external VPN gateway.

Enum type. Can be one of the following:
FOUR_IPS_REDUNDANCY The external VPN gateway has four public IP addresses; at the time of writing this API, the AWS virtual private gateway is an example which has four public IP addresses for high availability connections; there should be two VPN connections in the AWS virtual private gateway , each AWS VPN connection has two public IP addresses; please make sure to put two public IP addresses from one AWS VPN connection into interfaces 0 and 1 of this external VPN gateway, and put the other two public IP addresses from another AWS VPN connection into interfaces 2 and 3 of this external VPN gateway. When displaying highly available configuration status for the VPN tunnels connected to FOUR_IPS_REDUNDANCY external VPN gateway, Google will always detect whether interfaces 0 and 1 are connected on one interface of HA Cloud VPN gateway, and detect whether interfaces 2 and 3 are connected to another interface of the HA Cloud VPN gateway.
SINGLE_IP_INTERNALLY_REDUNDANT The external VPN gateway has only one public IP address which internally provide redundancy or failover.
TWO_IPS_REDUNDANCY The external VPN gateway has two public IP addresses which are redundant with each other, the following two types of setup on your on-premises side would have this type of redundancy: (1) Two separate on-premises gateways, each with one public IP address, the two on-premises gateways are redundant with each other. (2) A single on-premise gateway with two public IP addresses that are redundant with eatch other.
selfLink

string

[Output Only] Server-defined URL for the resource.

ExternalVpnGatewayInterface

The interface for the external VPN gateway.
Fields
id

integer (uint32 format)

The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3

ipAddress

string

IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.

ExternalVpnGatewayList

Response to the list request, and contains a list of externalVpnGateways.
Fields
etag

string

(No description provided)

id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (ExternalVpnGateway)

A list of ExternalVpnGateway resources.

kind

string

[Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

FileContentBuffer

(No description provided)
Fields
content

string (bytes format)

The raw content in the secure keys file.

fileType

enum

The file type of source file.

Enum type. Can be one of the following:
BIN (No description provided)
UNDEFINED (No description provided)
X509 (No description provided)

Firewall

Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
Fields
allowed[]

object

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

allowed.IPProtocol

string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

allowed.ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

denied[]

object

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

denied.IPProtocol

string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

denied.ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

description

string

An optional description of this resource. Provide this field when you create the resource.

destinationRanges[]

string

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

direction

enum

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields.

Enum type. Can be one of the following:
EGRESS Indicates that firewall should apply to outgoing traffic.
INGRESS Indicates that firewall should apply to incoming traffic.
disabled

boolean

Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#firewall for firewall rules.

logConfig

object (FirewallLogConfig)

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

network

string

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, 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/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

priority

integer (int32 format)

Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

selfLink

string

[Output Only] Server-defined URL for the resource.

sourceRanges[]

string

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

sourceServiceAccounts[]

string

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

sourceTags[]

string

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

targetServiceAccounts[]

string

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

targetTags[]

string

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

FirewallList

Contains a list of firewalls.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Firewall)

A list of Firewall resources.

kind

string

[Output Only] Type of resource. Always compute#firewallList for lists of firewalls.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

FirewallLogConfig

The available logging options for a firewall rule.
Fields
enable

boolean

This field denotes whether to enable logging for a particular firewall rule.

metadata

enum

This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

Enum type. Can be one of the following:
EXCLUDE_ALL_METADATA (No description provided)
INCLUDE_ALL_METADATA (No description provided)

FirewallPoliciesListAssociationsResponse

(No description provided)
Fields
associations[]

object (FirewallPolicyAssociation)

A list of associations.

kind

string

[Output Only] Type of firewallPolicy associations. Always compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations.

FirewallPolicy

Represents a Firewall Policy resource.
Fields
associations[]

object (FirewallPolicyAssociation)

A list of associations that belong to this firewall policy.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

displayName

string

Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

fingerprint

string (bytes format)

Specifies a fingerprint for this resource, 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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

name

string

Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

parent

string

[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.

region

string

[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

ruleTupleCount

integer (int32 format)

[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

rules[]

object (FirewallPolicyRule)

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

selfLink

string

[Output Only] Server-defined URL for the resource.

selfLinkWithId

string

[Output Only] Server-defined URL for this resource with the resource id.

shortName

string

User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

FirewallPolicyAssociation

(No description provided)
Fields
attachmentTarget

string

The target that the firewall policy is attached to.

displayName

string

[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.

firewallPolicyId

string

[Output Only] The firewall policy ID of the association.

name

string

The name for an association.

shortName

string

[Output Only] The short name of the firewall policy of the association.

FirewallPolicyList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (FirewallPolicy)

A list of FirewallPolicy resources.

kind

string

[Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

FirewallPolicyRule

Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
Fields
action

string

The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

description

string

An optional description for this resource.

direction

enum

The direction in which this rule applies.

Enum type. Can be one of the following:
EGRESS (No description provided)
INGRESS (No description provided)
disabled

boolean

Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

enableLogging

boolean

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

kind

string

[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

match

object (FirewallPolicyRuleMatcher)

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

priority

integer (int32 format)

An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

ruleName

string

An optional name for the rule. This field is not a unique identifier and can be updated.

ruleTupleCount

integer (int32 format)

[Output Only] Calculation of the complexity of a single firewall policy rule.

targetResources[]

string

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

targetSecureTags[]

object (FirewallPolicyRuleSecureTag)

A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

targetServiceAccounts[]

string

A list of service accounts indicating the sets of instances that are applied with this rule.

FirewallPolicyRuleMatcher

Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.
Fields
destAddressGroups[]

string

Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.

destFqdns[]

string

Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.

destIpRanges[]

string

CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.

destRegionCodes[]

string

Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.

destThreatIntelligences[]

string

Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.

layer4Configs[]

object (FirewallPolicyRuleMatcherLayer4Config)

Pairs of IP protocols and ports that the rule should match.

srcAddressGroups[]

string

Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.

srcFqdns[]

string

Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.

srcIpRanges[]

string

CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.

srcRegionCodes[]

string

Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.

srcSecureTags[]

object (FirewallPolicyRuleSecureTag)

List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

srcThreatIntelligences[]

string

Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.

FirewallPolicyRuleMatcherLayer4Config

(No description provided)
Fields
ipProtocol

string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

FirewallPolicyRuleSecureTag

(No description provided)
Fields
name

string

Name of the secure tag, created with TagManager's TagValue API.

state

enum

[Output Only] State of the secure tag, either EFFECTIVE or INEFFECTIVE. A secure tag is INEFFECTIVE when it is deleted or its network is deleted.

Enum type. Can be one of the following:
EFFECTIVE (No description provided)
INEFFECTIVE (No description provided)

FixedOrPercent

Encapsulates numeric value that can be either absolute or relative.
Fields
calculated

integer (int32 format)

[Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.

fixed

integer (int32 format)

Specifies a fixed number of VM instances. This must be a positive integer.

percent

integer (int32 format)

Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

ForwardingRule

Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * Global * Regional A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.
Fields
IPAddress

string

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in 100.1.2.3 * IPv6 address range, as in 2600:1234::/96 * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see IP address specifications. When reading an IPAddress, the API always returns the IP address number.

IPProtocol

enum

The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in Load balancing features.

Enum type. Can be one of the following:
AH (No description provided)
ESP (No description provided)
ICMP (No description provided)
L3_DEFAULT (No description provided)
SCTP (No description provided)
TCP (No description provided)
UDP (No description provided)
allPorts

boolean

This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.

allowGlobalAccess

boolean

This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.

allowPscGlobalAccess

boolean

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

backendService

string

Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

baseForwardingRule

string

[Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

ipVersion

enum

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.

Enum type. Can be one of the following:
IPV4 (No description provided)
IPV6 (No description provided)
UNSPECIFIED_VERSION (No description provided)
isMirroringCollector

boolean

Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.

kind

string

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

loadBalancingScheme

enum

Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.

Enum type. Can be one of the following:
EXTERNAL (No description provided)
EXTERNAL_MANAGED (No description provided)
INTERNAL (No description provided)
INTERNAL_MANAGED (No description provided)
INTERNAL_SELF_MANAGED (No description provided)
INVALID (No description provided)
metadataFilters[]

object (MetadataFilter)

Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.

network

string

This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

networkTier

enum

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.

Enum type. Can be one of the following:
FIXED_STANDARD Public internet quality with fixed bandwidth.
PREMIUM High quality, Google-grade network tier, support for all networking products.
STANDARD Public internet quality, only limited support for other networking products.
STANDARD_OVERRIDES_FIXED_STANDARD (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
noAutomateDnsZone

boolean

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable.

portRange

string

This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \d+(?:-\d+)?

ports[]

string

This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \d+(?:-\d+)?

pscConnectionId

string (uint64 format)

[Output Only] The PSC connection id of the PSC Forwarding Rule.

pscConnectionStatus

enum

(No description provided)

Enum type. Can be one of the following:
ACCEPTED The connection has been accepted by the producer.
CLOSED The connection has been closed by the producer and will not serve traffic going forward.
NEEDS_ATTENTION The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
PENDING The connection is pending acceptance by the producer.
REJECTED The connection has been rejected by the producer.
STATUS_UNSPECIFIED (No description provided)
region

string

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

serviceDirectoryRegistrations[]

object (ForwardingRuleServiceDirectoryRegistration)

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

serviceLabel

string

An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.

serviceName

string

[Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.

sourceIpRanges[]

string

If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).

subnetwork

string

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.

target

string

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in Port specifications. - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.

ForwardingRuleAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (ForwardingRulesScopedList))

A list of ForwardingRulesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ForwardingRuleList

Contains a list of ForwardingRule resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (ForwardingRule)

A list of ForwardingRule resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ForwardingRuleReference

(No description provided)
Fields
forwardingRule

string

(No description provided)

ForwardingRuleServiceDirectoryRegistration

Describes the auto-registration of the Forwarding Rule to Service Directory. The region and project of the Service Directory resource generated from this registration will be the same as this Forwarding Rule.
Fields
namespace

string

Service Directory namespace to register the forwarding rule under.

service

string

Service Directory service to register the forwarding rule under.

serviceDirectoryRegion

string

[Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.

ForwardingRulesScopedList

(No description provided)
Fields
forwardingRules[]

object (ForwardingRule)

A list of forwarding rules contained in this scope.

warning

object

Informational warning which replaces the list of forwarding rules when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

GRPCHealthCheck

(No description provided)
Fields
grpcServiceName

string

The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII.

port

integer (int32 format)

The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.

portName

string

Not supported.

portSpecification

enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.

Enum type. Can be one of the following:
USE_FIXED_PORT The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
USE_NAMED_PORT Not supported.
USE_SERVING_PORT For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.

GlobalAddressesMoveRequest

(No description provided)
Fields
description

string

An optional destination address description if intended to be different from the source.

destinationAddress

string

The URL of the destination address to move to. This can be a full or partial URL. For example, the following are all valid URLs to a address: - https://www.googleapis.com/compute/v1/projects/project /global/addresses/address - projects/project/global/addresses/address Note that destination project must be different from the source project. So /global/addresses/address is not valid partial url.

GlobalNetworkEndpointGroupsAttachEndpointsRequest

(No description provided)
Fields
networkEndpoints[]

object (NetworkEndpoint)

The list of network endpoints to be attached.

GlobalNetworkEndpointGroupsDetachEndpointsRequest

(No description provided)
Fields
networkEndpoints[]

object (NetworkEndpoint)

The list of network endpoints to be detached.

GlobalOrganizationSetPolicyRequest

(No description provided)
Fields
bindings[]

object (Binding)

Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

etag

string (bytes format)

Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

policy

object (Policy)

REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

GlobalSetLabelsRequest

(No description provided)
Fields
labelFingerprint

string (bytes format)

The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.

labels

map (key: string, value: string)

A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").

GlobalSetPolicyRequest

(No description provided)
Fields
bindings[]

object (Binding)

Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

etag

string (bytes format)

Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

policy

object (Policy)

REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

GuestAttributes

A guest attributes entry.
Fields
kind

string

[Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

queryPath

string

The path to be queried. This can be the default namespace ('') or a nested namespace ('\/') or a specified key ('\/\').

queryValue

object (GuestAttributesValue)

[Output Only] The value of the requested queried path.

selfLink

string

[Output Only] Server-defined URL for this resource.

variableKey

string

The key to search for.

variableValue

string

[Output Only] The value found for the requested key.

GuestAttributesEntry

A guest attributes namespace/key/value entry.
Fields
key

string

Key for the guest attribute entry.

namespace

string

Namespace for the guest attribute entry.

value

string

Value for the guest attribute entry.

GuestAttributesValue

Array of guest attribute namespace/key/value tuples.
Fields
items[]

object (GuestAttributesEntry)

(No description provided)

GuestOsFeature

Guest OS features.
Fields
type

enum

The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features.

Enum type. Can be one of the following:
FEATURE_TYPE_UNSPECIFIED (No description provided)
GVNIC (No description provided)
MULTI_IP_SUBNET (No description provided)
SECURE_BOOT (No description provided)
SEV_CAPABLE (No description provided)
SEV_LIVE_MIGRATABLE (No description provided)
SEV_SNP_CAPABLE (No description provided)
UEFI_COMPATIBLE (No description provided)
VIRTIO_SCSI_MULTIQUEUE (No description provided)
WINDOWS (No description provided)

HTTP2HealthCheck

(No description provided)
Fields
host

string

The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

port

integer (int32 format)

The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.

portName

string

Not supported.

portSpecification

enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.

Enum type. Can be one of the following:
USE_FIXED_PORT The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
USE_NAMED_PORT Not supported.
USE_SERVING_PORT For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.
proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)
requestPath

string

The request path of the HTTP/2 health check request. The default value is /.

response

string

Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

HTTPHealthCheck

(No description provided)
Fields
host

string

The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

port

integer (int32 format)

The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.

portName

string

Not supported.

portSpecification

enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.

Enum type. Can be one of the following:
USE_FIXED_PORT The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
USE_NAMED_PORT Not supported.
USE_SERVING_PORT For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.
proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)
requestPath

string

The request path of the HTTP health check request. The default value is /.

response

string

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

HTTPSHealthCheck

(No description provided)
Fields
host

string

The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

port

integer (int32 format)

The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.

portName

string

Not supported.

portSpecification

enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.

Enum type. Can be one of the following:
USE_FIXED_PORT The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
USE_NAMED_PORT Not supported.
USE_SERVING_PORT For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.
proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)
requestPath

string

The request path of the HTTPS health check request. The default value is /.

response

string

Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

HealthCheck

Represents a Health Check resource. Google Compute Engine has two Health Check resources: * Global * Regional Internal HTTP(S) load balancers must use regional health checks (compute.v1.regionHealthChecks). Traffic Director must use global health checks (compute.v1.healthChecks). Internal TCP/UDP load balancers can use either regional or global health checks (compute.v1.regionHealthChecks or compute.v1.healthChecks). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (compute.v1.healthChecks). Backend service-based network load balancers must use regional health checks (compute.v1.regionHealthChecks). Target pool-based network load balancers must use legacy HTTP health checks (compute.v1.httpHealthChecks). For more information, see Health checks overview.
Fields
checkIntervalSec

integer (int32 format)

How often (in seconds) to send a health check. The default value is 5 seconds.

creationTimestamp

string

[Output Only] Creation timestamp in 3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

grpcHealthCheck

object (GRPCHealthCheck)

(No description provided)

healthyThreshold

integer (int32 format)

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

http2HealthCheck

object (HTTP2HealthCheck)

(No description provided)

httpHealthCheck

object (HTTPHealthCheck)

(No description provided)

httpsHealthCheck

object (HTTPSHealthCheck)

(No description provided)

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

Type of the resource.

logConfig

object (HealthCheckLogConfig)

Configure logging on this health check.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.

region

string

[Output Only] Region where the health check resides. Not applicable to global health checks.

selfLink

string

[Output Only] Server-defined URL for the resource.

sslHealthCheck

object (SSLHealthCheck)

(No description provided)

tcpHealthCheck

object (TCPHealthCheck)

(No description provided)

timeoutSec

integer (int32 format)

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

type

enum

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.

Enum type. Can be one of the following:
GRPC (No description provided)
HTTP (No description provided)
HTTP2 (No description provided)
HTTPS (No description provided)
INVALID (No description provided)
SSL (No description provided)
TCP (No description provided)
unhealthyThreshold

integer (int32 format)

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

HealthCheckList

Contains a list of HealthCheck resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (HealthCheck)

A list of HealthCheck resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

HealthCheckLogConfig

Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.
Fields
enable

boolean

Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

HealthCheckReference

A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check
Fields
healthCheck

string

(No description provided)

HealthCheckService

Represents a Health-Check as a Service resource.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.

healthChecks[]

string

A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.

healthStatusAggregationPolicy

enum

Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService.

Enum type. Can be one of the following:
AND If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY.
NO_AGGREGATION An EndpointHealth message is returned for each backend in the health check service.
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

name

string

Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

networkEndpointGroups[]

string

A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.

notificationEndpoints[]

string

A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.

region

string

[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

HealthCheckServiceReference

A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service
Fields
healthCheckService

string

(No description provided)

HealthCheckServicesList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (HealthCheckService)

A list of HealthCheckService resources.

kind

string

[Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

HealthChecksAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (HealthChecksScopedList))

A list of HealthChecksScopedList resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

HealthChecksScopedList

(No description provided)
Fields
healthChecks[]

object (HealthCheck)

A list of HealthChecks contained in this scope.

warning

object

Informational warning which replaces the list of backend services when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

HealthStatus

(No description provided)
Fields
annotations

map (key: string, value: string)

Metadata defined as annotations for network endpoint.

forwardingRule

string

URL of the forwarding rule associated with the health status of the instance.

forwardingRuleIp

string

A forwarding rule IP address assigned to this instance.

healthState

enum

Health state of the IPv4 address of the instance.

Enum type. Can be one of the following:
HEALTHY (No description provided)
UNHEALTHY (No description provided)
instance

string

URL of the instance resource.

ipAddress

string

For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.

port

integer (int32 format)

The named port of the instance group, not necessarily the port that is health-checked.

weight

string

(No description provided)

weightError

enum

(No description provided)

Enum type. Can be one of the following:
INVALID_WEIGHT The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).
MISSING_WEIGHT The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.
UNAVAILABLE_WEIGHT This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.
WEIGHT_NONE This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight.

HealthStatusForNetworkEndpoint

(No description provided)
Fields
backendService

object (BackendServiceReference)

URL of the backend service associated with the health state of the network endpoint.

forwardingRule

object (ForwardingRuleReference)

URL of the forwarding rule associated with the health state of the network endpoint.

healthCheck

object (HealthCheckReference)

URL of the health check associated with the health state of the network endpoint.

healthCheckService

object (HealthCheckServiceReference)

URL of the health check service associated with the health state of the network endpoint.

healthState

enum

Health state of the network endpoint determined based on the health checks configured.

Enum type. Can be one of the following:
DRAINING Endpoint is being drained.
HEALTHY Endpoint is healthy.
UNHEALTHY Endpoint is unhealthy.
UNKNOWN Health status of the endpoint is unknown.

Help

Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
Fields
links[]

object (HelpLink)

URL(s) pointing to additional information on handling the current error.

HostRule

UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Fields
description

string

An optional description of this resource. Provide this property when you create the resource.

hosts[]

string

The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

pathMatcher

string

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

HttpFaultAbort

Specification for how requests are aborted as part of fault injection.
Fields
httpStatus

integer (uint32 format)

The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

percentage

number (double format)

The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.

HttpFaultDelay

Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.
Fields
fixedDelay

object (Duration)

Specifies the value of the fixed delay interval.

percentage

number (double format)

The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.

HttpFaultInjection

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.
Fields
abort

object (HttpFaultAbort)

The specification for how client requests are aborted as part of fault injection.

delay

object (HttpFaultDelay)

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

HttpHeaderAction

The request and response header transformations that take effect before the request is passed along to the selected backendService.
Fields
requestHeadersToAdd[]

object (HttpHeaderOption)

Headers to add to a matching request before forwarding the request to the backendService.

requestHeadersToRemove[]

string

A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.

responseHeadersToAdd[]

object (HttpHeaderOption)

Headers to add the response before sending the response back to the client.

responseHeadersToRemove[]

string

A list of header names for headers that need to be removed from the response before sending the response back to the client.

HttpHeaderMatch

matchRule criteria for request header matches.
Fields
exactMatch

string

The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

headerName

string

The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the content-type header are supported. The following transport-level headers cannot be used in header matching rules: :authority, :method, :path, :scheme, user-agent, accept-encoding, content-encoding, grpc-accept-encoding, grpc-encoding, grpc-previous-rpc-attempts, grpc-tags-bin, grpc-timeout and grpc-trace-bin.

invertMatch

boolean

If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false.

prefixMatch

string

The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

presentMatch

boolean

A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

rangeMatch

object (Int64RangeMatch)

The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL.

regexMatch

string

The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

suffixMatch

string

The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

HttpHeaderOption

Specification determining how headers are added to requests or responses.
Fields
headerName

string

The name of the header.

headerValue

string

The value of the header to add.

replace

boolean

If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

HttpHealthCheck

Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .
Fields
checkIntervalSec

integer (int32 format)

How often (in seconds) to send a health check. The default value is 5 seconds.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

healthyThreshold

integer (int32 format)

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

host

string

The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

port

integer (int32 format)

The TCP port number for the HTTP health check request. The default value is 80.

requestPath

string

The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.

selfLink

string

[Output Only] Server-defined URL for the resource.

timeoutSec

integer (int32 format)

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

unhealthyThreshold

integer (int32 format)

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

HttpHealthCheckList

Contains a list of HttpHealthCheck resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (HttpHealthCheck)

A list of HttpHealthCheck resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

HttpQueryParameterMatch

HttpRouteRuleMatch criteria for a request's query parameter.
Fields
exactMatch

string

The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch, or regexMatch must be set.

name

string

The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

presentMatch

boolean

Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch, or regexMatch must be set.

regexMatch

string

The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For more information about regular expression syntax, see Syntax. Only one of presentMatch, exactMatch, or regexMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

HttpRedirectAction

Specifies settings for an HTTP redirect.
Fields
hostRedirect

string

The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.

httpsRedirect

boolean

If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

pathRedirect

string

The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.

prefixRedirect

string

The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.

redirectResponseCode

enum

The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.

Enum type. Can be one of the following:
FOUND Http Status Code 302 - Found.
MOVED_PERMANENTLY_DEFAULT Http Status Code 301 - Moved Permanently.
PERMANENT_REDIRECT Http Status Code 308 - Permanent Redirect maintaining HTTP method.
SEE_OTHER Http Status Code 303 - See Other.
TEMPORARY_REDIRECT Http Status Code 307 - Temporary Redirect maintaining HTTP method.
stripQuery

boolean

If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.

HttpRetryPolicy

The retry policy associates with HttpRouteRule
Fields
numRetries

integer (uint32 format)

Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

perTryTimeout

object (Duration)

Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the HttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

retryConditions[]

string

Specifies one or more conditions when this retry policy applies. Valid values are: - 5xx: retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - connect-failure: a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts. - retriable-4xx: a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409. - refused-stream: a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: a retry is attempted if the gRPC status code in the response header is set to cancelled. - deadline-exceeded: a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded. - internal: a retry is attempted if the gRPC status code in the response header is set to internal. - resource-exhausted: a retry is attempted if the gRPC status code in the response header is set to resource-exhausted. - unavailable: a retry is attempted if the gRPC status code in the response header is set to unavailable. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true. - cancelled - deadline-exceeded - internal - resource-exhausted - unavailable

HttpRouteAction

(No description provided)
Fields
corsPolicy

object (CorsPolicy)

The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy.

faultInjectionPolicy

object (HttpFaultInjection)

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the global external HTTP(S) load balancer (classic). To see which load balancers support fault injection, see Load balancing: Routing and traffic management features.

maxStreamDuration

object (Duration)

Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

requestMirrorPolicy

object (RequestMirrorPolicy)

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

retryPolicy

object (HttpRetryPolicy)

Specifies the retry policy associated with this route.

timeout

object (Duration)

Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

urlRewrite

object (UrlRewrite)

The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

weightedBackendServices[]

object (WeightedBackendService)

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

HttpRouteRule

The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.
Fields
description

string

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

headerAction

object (HttpHeaderAction)

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

matchRules[]

object (HttpRouteRuleMatch)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

priority

integer (int32 format)

For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

routeAction

object (HttpRouteAction)

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction.

service

string

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

urlRedirect

object (HttpRedirectAction)

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

HttpRouteRuleMatch

HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
Fields
fullPathMatch

string

For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

headerMatches[]

object (HttpHeaderMatch)

Specifies a list of header match criteria, all of which must match corresponding headers in the request.

ignoreCase

boolean

Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.

metadataFilters[]

object (MetadataFilter)

Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

pathTemplateMatch

string

If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash ("/") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.

prefixMatch

string

For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

queryParameterMatches[]

object (HttpQueryParameterMatch)

Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.

regexMatch

string

For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

HttpsHealthCheck

Represents a legacy HTTPS Health Check resource. Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .
Fields
checkIntervalSec

integer (int32 format)

How often (in seconds) to send a health check. The default value is 5 seconds.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

healthyThreshold

integer (int32 format)

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

host

string

The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

Type of the resource.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

port

integer (int32 format)

The TCP port number for the HTTPS health check request. The default value is 443.

requestPath

string

The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986.

selfLink

string

[Output Only] Server-defined URL for the resource.

timeoutSec

integer (int32 format)

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.

unhealthyThreshold

integer (int32 format)

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

HttpsHealthCheckList

Contains a list of HttpsHealthCheck resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (HttpsHealthCheck)

A list of HttpsHealthCheck resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

Image

Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.
Fields
architecture

enum

The architecture of the image. Valid values are ARM64 or X86_64.

Enum type. Can be one of the following:
ARCHITECTURE_UNSPECIFIED Default value indicating Architecture is not set.
ARM64 Machines with architecture ARM64
X86_64 Machines with architecture X86_64
archiveSizeBytes

string (int64 format)

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated

object (DeprecationStatus)

The deprecation status associated with this image.

description

string

An optional description of this resource. Provide this property when you create the resource.

diskSizeGb

string (int64 format)

Size of the image when restored onto a persistent disk (in GB).

family

string

The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

guestOsFeatures[]

object (GuestOsFeature)

A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

imageEncryptionKey

object (CustomerEncryptionKey)

Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

kind

string

[Output Only] Type of the resource. Always compute#image for images.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.

labels

map (key: string, value: string)

Labels to apply to this image. These can be later modified by the setLabels method.

licenseCodes[]

string (int64 format)

Integer license codes indicating which licenses are attached to this image.

licenses[]

string

Any applicable license URI.

name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

rawDisk

object

The parameters of the raw disk image.

rawDisk.containerType

enum

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

Enum type. Can be one of the following:
TAR (No description provided)
rawDisk.sha1Checksum

string

[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.

rawDisk.source

string

The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

satisfiesPzs

boolean

[Output Only] Reserved for future use.

selfLink

string

[Output Only] Server-defined URL for the resource.

shieldedInstanceInitialState

object (InitialStateConfig)

Set the secure boot keys of shielded instance.

sourceDisk

string

URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

sourceDiskEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

sourceDiskId

string

[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

sourceImage

string

URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

sourceImageEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

sourceImageId

string

[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.

sourceSnapshot

string

URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

sourceSnapshotEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

sourceSnapshotId

string

[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.

sourceType

enum

The type of the image used to create this disk. The default and only valid value is RAW.

Enum type. Can be one of the following:
RAW (No description provided)
status

enum

[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

Enum type. Can be one of the following:
DELETING Image is deleting.
FAILED Image creation failed due to an error.
PENDING Image hasn't been created as yet.
READY Image has been successfully created.
storageLocations[]

string

Cloud Storage bucket storage location of the image (regional or multi-regional).

ImageFamilyView

(No description provided)
Fields
image

object (Image)

The latest image that is part of the specified image family in the requested location, and that is not deprecated.

image.rawDisk.containerType

enum

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

Enum type. Can be one of the following:
TAR (No description provided)
image.rawDisk.sha1Checksum

string

[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.

image.rawDisk.source

string

The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

ImageList

Contains a list of images.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Image)

A list of Image resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InitialStateConfig

Initial State for shielded instance, these are public keys which are safe to store in public
Fields
dbs[]

object (FileContentBuffer)

The Key Database (db).

dbxs[]

object (FileContentBuffer)

The forbidden key database (dbx).

keks[]

object (FileContentBuffer)

The Key Exchange Key (KEK).

pk

object (FileContentBuffer)

The Platform Key (PK).

Instance

Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.
Fields
advancedMachineFeatures

object (AdvancedMachineFeatures)

Controls for advanced machine-related behavior features.

canIpForward

boolean

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 .

confidentialInstanceConfig

object (ConfidentialInstanceConfig)

(No description provided)

cpuPlatform

string

[Output Only] The CPU platform used by this instance.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

deletionProtection

boolean

Whether the resource should be protected against deletion.

description

string

An optional description of this resource. Provide this property when you create the resource.

disks[]

object (AttachedDisk)

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

displayDevice

object (DisplayDevice)

Enables display device for the instance.

fingerprint

string (bytes format)

Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.

guestAccelerators[]

object (AcceleratorConfig)

A list of the type and count of accelerator cards attached to the instance.

hostname

string

Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

instanceEncryptionKey

object (CustomerEncryptionKey)

Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.

keyRevocationActionType

enum

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.

Enum type. Can be one of the following:
KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED Default value. This value is unused.
NONE Indicates user chose no operation.
STOP Indicates user chose to opt for VM shutdown on key revocation.
kind

string

[Output Only] Type of the resource. Always compute#instance for instances.

labelFingerprint

string (bytes format)

A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.

labels

map (key: string, value: string)

Labels to apply to this instance. These can be later modified by the setLabels method.

lastStartTimestamp

string

[Output Only] Last start timestamp in RFC3339 text format.

lastStopTimestamp

string

[Output Only] Last stop timestamp in RFC3339 text format.

lastSuspendedTimestamp

string

[Output Only] Last suspended timestamp in RFC3339 text format.

machineType

string

Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

metadata

object (Metadata)

The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

metadata.items.key

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.

metadata.items.value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

minCpuPlatform

string

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

name

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

networkInterfaces[]

object (NetworkInterface)

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

networkPerformanceConfig

object (NetworkPerformanceConfig)

(No description provided)

params

object (InstanceParams)

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

privateIpv6GoogleAccess

enum

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

Enum type. Can be one of the following:
ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
INHERIT_FROM_SUBNETWORK Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
reservationAffinity

object (ReservationAffinity)

Specifies the reservations that this instance can consume from.

resourcePolicies[]

string

Resource policies applied to this instance.

resourceStatus

object (ResourceStatus)

[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

scheduling

object (Scheduling)

Sets the scheduling options for this instance.

selfLink

string

[Output Only] Server-defined URL for this resource.

serviceAccounts[]

object (ServiceAccount)

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

shieldedInstanceConfig

object (ShieldedInstanceConfig)

(No description provided)

shieldedInstanceIntegrityPolicy

object (ShieldedInstanceIntegrityPolicy)

(No description provided)

sourceMachineImage

string

Source machine image

sourceMachineImageEncryptionKey

object (CustomerEncryptionKey)

Source machine image encryption key when creating an instance from a machine image.

startRestricted

boolean

[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

status

enum

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Enum type. Can be one of the following:
DEPROVISIONING The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
PROVISIONING Resources are being allocated for the instance.
REPAIRING The instance is in repair.
RUNNING The instance is running.
STAGING All required resources have been allocated and the instance is being started.
STOPPED The instance has stopped successfully.
STOPPING The instance is currently stopping (either being deleted or killed).
SUSPENDED The instance has suspended.
SUSPENDING The instance is suspending.
TERMINATED The instance has stopped (either by explicit action or underlying failure).
statusMessage

string

[Output Only] An optional, human-readable explanation of the status.

tags

object (Tags)

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. Multiple tags can be specified via the 'tags.items' field.

zone

string

[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

InstanceAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (InstancesScopedList))

An object that contains a list of instances scoped by zone.

kind

string

[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceConsumptionData

(No description provided)
Fields
consumptionInfo

object (InstanceConsumptionInfo)

Resources consumed by the instance.

instance

string

Server-defined URL for the instance.

InstanceConsumptionInfo

(No description provided)
Fields
guestCpus

integer (int32 format)

The number of virtual CPUs that are available to the instance.

localSsdGb

integer (int32 format)

The amount of local SSD storage available to the instance, defined in GiB.

memoryMb

integer (int32 format)

The amount of physical memory available to the instance, defined in MiB.

minNodeCpus

integer (int32 format)

The minimal guaranteed number of virtual CPUs that are reserved.

InstanceGroup

Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups.
Fields
creationTimestamp

string

[Output Only] The creation timestamp for this instance group in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

id

string (uint64 format)

[Output Only] A unique identifier for this instance group, generated by the server.

kind

string

[Output Only] The resource type, which is always compute#instanceGroup for instance groups.

name

string

The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

namedPorts[]

object (NamedPort)

Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group.

network

string

[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

region

string

[Output Only] The URL of the region where the instance group is located (for regional resources).

selfLink

string

[Output Only] The URL for this instance group. The server generates this URL.

size

integer (int32 format)

[Output Only] The total number of instances in the instance group.

subnetwork

string

[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

zone

string

[Output Only] The URL of the zone where the instance group is located (for zonal resources).

InstanceGroupAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (InstanceGroupsScopedList))

A list of InstanceGroupsScopedList resources.

kind

string

[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceGroupList

A list of InstanceGroup resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InstanceGroup)

A list of InstanceGroup resources.

kind

string

[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceGroupManager

Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.
Fields
autoHealingPolicies[]

object (InstanceGroupManagerAutoHealingPolicy)

The autohealing policy for this managed instance group. You can specify only one value.

baseInstanceName

string

The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

creationTimestamp

string

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

currentActions

object (InstanceGroupManagerActionsSummary)

[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

description

string

An optional description of this resource.

distributionPolicy

object (DistributionPolicy)

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

fingerprint

string (bytes format)

Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

id

string (uint64 format)

[Output Only] A unique identifier for this resource type. The server generates this identifier.

instanceGroup

string

[Output Only] The URL of the Instance Group resource.

instanceLifecyclePolicy

object (InstanceGroupManagerInstanceLifecyclePolicy)

The repair policy for this managed instance group.

instanceTemplate

string

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

kind

string

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

listManagedInstancesResults

enum

Pagination behavior of the listManagedInstances API method for this managed instance group.

Enum type. Can be one of the following:
PAGELESS (Default) Pagination is disabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response.
PAGINATED Pagination is enabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are respected.
name

string

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

namedPorts[]

object (NamedPort)

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

region

string

[Output Only] The URL of the region where the managed instance group resides (for regional resources).

selfLink

string

[Output Only] The URL for this managed instance group. The server defines this URL.

statefulPolicy

object (StatefulPolicy)

Stateful configuration for this Instanced Group Manager

status

object (InstanceGroupManagerStatus)

[Output Only] The status of this managed instance group.

targetPools[]

string

The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

targetSize

integer (int32 format)

The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.

updatePolicy

object (InstanceGroupManagerUpdatePolicy)

The update policy for this managed instance group.

versions[]

object (InstanceGroupManagerVersion)

Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

zone

string

[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

InstanceGroupManagerActionsSummary

(No description provided)
Fields
abandoning

integer (int32 format)

[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.

creating

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

creatingWithoutRetries

integer (int32 format)

[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.

deleting

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

none

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

recreating

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.

refreshing

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.

restarting

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

resuming

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.

starting

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.

stopping

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.

suspending

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.

verifying

integer (int32 format)

[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.

InstanceGroupManagerAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (InstanceGroupManagersScopedList))

A list of InstanceGroupManagersScopedList resources.

kind

string

[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceGroupManagerAutoHealingPolicy

(No description provided)
Fields
healthCheck

string

The URL for the health check that signals autohealing.

initialDelaySec

integer (int32 format)

The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.

InstanceGroupManagerInstanceLifecyclePolicy

(No description provided)
Fields
forceUpdateOnRepair

enum

A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair.

Enum type. Can be one of the following:
NO (No description provided)
YES (No description provided)

InstanceGroupManagerList

[Output Only] A list of managed instance groups.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InstanceGroupManager)

A list of InstanceGroupManager resources.

kind

string

[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceGroupManagerStatus

(No description provided)
Fields
autoscaler

string

[Output Only] The URL of the Autoscaler that targets this instance group manager.

isStable

boolean

[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.

stateful

object (InstanceGroupManagerStatusStateful)

[Output Only] Stateful status of the given Instance Group Manager.

versionTarget

object (InstanceGroupManagerStatusVersionTarget)

[Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

InstanceGroupManagerStatusStateful

(No description provided)
Fields
hasStatefulConfig

boolean

[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.

perInstanceConfigs

object (InstanceGroupManagerStatusStatefulPerInstanceConfigs)

[Output Only] Status of per-instance configurations on the instance.

InstanceGroupManagerStatusStatefulPerInstanceConfigs

(No description provided)
Fields
allEffective

boolean

A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.

InstanceGroupManagerStatusVersionTarget

(No description provided)
Fields
isReached

boolean

[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.

InstanceGroupManagerUpdatePolicy

(No description provided)
Fields
instanceRedistributionType

enum

The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled.

Enum type. Can be one of the following:
NONE No action is being proactively performed in order to bring this IGM to its target instance distribution.
PROACTIVE This IGM will actively converge to its target instance distribution.
maxSurge

object (FixedOrPercent)

The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

maxUnavailable

object (FixedOrPercent)

The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

minimalAction

enum

Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes.

Enum type. Can be one of the following:
NONE Do not perform any action.
REFRESH Do not stop the instance.
REPLACE (Default.) Replace the instance according to the replacement method option.
RESTART Stop the instance and start it again.
mostDisruptiveAllowedAction

enum

Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.

Enum type. Can be one of the following:
NONE Do not perform any action.
REFRESH Do not stop the instance.
REPLACE (Default.) Replace the instance according to the replacement method option.
RESTART Stop the instance and start it again.
replacementMethod

enum

What action should be used to replace instances. See minimal_action.REPLACE

Enum type. Can be one of the following:
RECREATE Instances will be recreated (with the same name)
SUBSTITUTE Default option: instances will be deleted and created (with a new name)
type

enum

The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update.

Enum type. Can be one of the following:
OPPORTUNISTIC MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.
PROACTIVE MIG will automatically apply new configurations to all or a subset of existing VMs and also to new VMs that are added to the group.

InstanceGroupManagerVersion

(No description provided)
Fields
instanceTemplate

string

The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the targetSize for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the targetSize for this version is reached.

name

string

Name of the version. Unique among all versions in the scope of this managed instance group.

targetSize

object (FixedOrPercent)

Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

InstanceGroupManagersAbandonInstancesRequest

(No description provided)
Fields
instances[]

string

The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

InstanceGroupManagersApplyUpdatesRequest

InstanceGroupManagers.applyUpdatesToInstances
Fields
allInstances

boolean

Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.

instances[]

string

The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

minimalAction

enum

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.

Enum type. Can be one of the following:
NONE Do not perform any action.
REFRESH Do not stop the instance.
REPLACE (Default.) Replace the instance according to the replacement method option.
RESTART Stop the instance and start it again.
mostDisruptiveAllowedAction

enum

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.

Enum type. Can be one of the following:
NONE Do not perform any action.
REFRESH Do not stop the instance.
REPLACE (Default.) Replace the instance according to the replacement method option.
RESTART Stop the instance and start it again.

InstanceGroupManagersCreateInstancesRequest

InstanceGroupManagers.createInstances
Fields
instances[]

object (PerInstanceConfig)

[Required] List of specifications of per-instance configs.

InstanceGroupManagersDeleteInstancesRequest

(No description provided)
Fields
instances[]

string

The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.

skipInstancesOnValidationError

boolean

Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to false and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.

InstanceGroupManagersDeletePerInstanceConfigsReq

InstanceGroupManagers.deletePerInstanceConfigs
Fields
names[]

string

The list of instance names for which we want to delete per-instance configs on this managed instance group.

InstanceGroupManagersListErrorsResponse

(No description provided)
Fields
items[]

object (InstanceManagedByIgmError)

[Output Only] The list of errors of the managed instance group.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

InstanceGroupManagersListManagedInstancesResponse

(No description provided)
Fields
managedInstances[]

object (ManagedInstance)

[Output Only] The list of instances in the managed instance group.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

InstanceGroupManagersListPerInstanceConfigsResp

(No description provided)
Fields
items[]

object (PerInstanceConfig)

[Output Only] The list of PerInstanceConfig.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceGroupManagersPatchPerInstanceConfigsReq

InstanceGroupManagers.patchPerInstanceConfigs
Fields
perInstanceConfigs[]

object (PerInstanceConfig)

The list of per-instance configurations to insert or patch on this managed instance group.

InstanceGroupManagersRecreateInstancesRequest

(No description provided)
Fields
instances[]

string

The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

InstanceGroupManagersScopedList

(No description provided)
Fields
instanceGroupManagers[]

object (InstanceGroupManager)

[Output Only] The list of managed instance groups that are contained in the specified project and zone.

warning

object

[Output Only] The warning that replaces the list of managed instance groups when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceGroupManagersSetInstanceTemplateRequest

(No description provided)
Fields
instanceTemplate

string

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

InstanceGroupManagersSetTargetPoolsRequest

(No description provided)
Fields
fingerprint

string (bytes format)

The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.

targetPools[]

string

The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.

InstanceGroupManagersUpdatePerInstanceConfigsReq

InstanceGroupManagers.updatePerInstanceConfigs
Fields
perInstanceConfigs[]

object (PerInstanceConfig)

The list of per-instance configurations to insert or patch on this managed instance group.

InstanceGroupsAddInstancesRequest

(No description provided)
Fields
instances[]

object (InstanceReference)

The list of instances to add to the instance group.

InstanceGroupsListInstances

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InstanceWithNamedPorts)

A list of InstanceWithNamedPorts resources.

kind

string

[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceGroupsListInstancesRequest

(No description provided)
Fields
instanceState

enum

A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.

Enum type. Can be one of the following:
ALL Includes all instances in the generated list regardless of their state.
RUNNING Includes instances in the generated list only if they have a RUNNING state.

InstanceGroupsRemoveInstancesRequest

(No description provided)
Fields
instances[]

object (InstanceReference)

The list of instances to remove from the instance group.

InstanceGroupsScopedList

(No description provided)
Fields
instanceGroups[]

object (InstanceGroup)

[Output Only] The list of instance groups that are contained in this scope.

warning

object

[Output Only] An informational warning that replaces the list of instance groups when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceGroupsSetNamedPortsRequest

(No description provided)
Fields
fingerprint

string (bytes format)

The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.

namedPorts[]

object (NamedPort)

The list of named ports to set for this instance group.

InstanceList

Contains a list of instances.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Instance)

A list of Instance resources.

kind

string

[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceListReferrers

Contains a list of instance referrers.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Reference)

A list of Reference resources.

kind

string

[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceManagedByIgmError

(No description provided)
Fields
error

object (InstanceManagedByIgmErrorManagedInstanceError)

[Output Only] Contents of the error.

instanceActionDetails

object (InstanceManagedByIgmErrorInstanceActionDetails)

[Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional.

timestamp

string

[Output Only] The time that this error occurred. This value is in RFC3339 text format.

InstanceManagedByIgmErrorInstanceActionDetails

(No description provided)
Fields
action

enum

[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:

Enum type. Can be one of the following:
ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.
DELETING The managed instance group is permanently deleting this instance.
NONE The managed instance group has not scheduled any actions for this instance.
RECREATING The managed instance group is recreating this instance.
REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
RESTARTING The managed instance group is restarting this instance.
RESUMING The managed instance group is resuming this instance.
STARTING The managed instance group is starting this instance.
STOPPING The managed instance group is stopping this instance.
SUSPENDING The managed instance group is suspending this instance.
VERIFYING The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions).
instance

string

[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.

version

object (ManagedInstanceVersion)

[Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created.

InstanceManagedByIgmErrorManagedInstanceError

(No description provided)
Fields
code

string

[Output Only] Error code.

message

string

[Output Only] Error message.

InstanceMoveRequest

(No description provided)
Fields
destinationZone

string

The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone

targetInstance

string

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

InstanceParams

Additional instance params.
Fields
resourceManagerTags

map (key: string, value: string)

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

InstanceProperties

(No description provided)
Fields
advancedMachineFeatures

object (AdvancedMachineFeatures)

Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.

canIpForward

boolean

Enables instances created based on these properties 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, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

confidentialInstanceConfig

object (ConfidentialInstanceConfig)

Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.

description

string

An optional text description for the instances that are created from these properties.

disks[]

object (AttachedDisk)

An array of disks that are associated with the instances that are created from these properties.

guestAccelerators[]

object (AcceleratorConfig)

A list of guest accelerator cards' type and count to use for instances created from these properties.

keyRevocationActionType

enum

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.

Enum type. Can be one of the following:
KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED Default value. This value is unused.
NONE Indicates user chose no operation.
STOP Indicates user chose to opt for VM shutdown on key revocation.
labels

map (key: string, value: string)

Labels to apply to instances that are created from these properties.

machineType

string

The machine type to use for instances that are created from these properties.

metadata

object (Metadata)

The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

metadata.items.key

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.

metadata.items.value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

minCpuPlatform

string

Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

networkInterfaces[]

object (NetworkInterface)

An array of network access configurations for this interface.

networkPerformanceConfig

object (NetworkPerformanceConfig)

Note that for MachineImage, this is not supported yet.

privateIpv6GoogleAccess

enum

The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.

Enum type. Can be one of the following:
ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
INHERIT_FROM_SUBNETWORK Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
reservationAffinity

object (ReservationAffinity)

Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.

resourceManagerTags

map (key: string, value: string)

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

resourcePolicies[]

string

Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.

scheduling

object (Scheduling)

Specifies the scheduling options for the instances that are created from these properties.

serviceAccounts[]

object (ServiceAccount)

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

shieldedInstanceConfig

object (ShieldedInstanceConfig)

Note that for MachineImage, this is not supported yet.

tags

object (Tags)

A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

InstanceReference

(No description provided)
Fields
instance

string

The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances

InstanceTemplate

Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates.
Fields
creationTimestamp

string

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] A unique identifier for this instance template. The server defines this identifier.

kind

string

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

properties

object (InstanceProperties)

The instance properties for this instance template.

properties.metadata.items.key

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.

properties.metadata.items.value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

region

string

[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

selfLink

string

[Output Only] The URL for this instance template. The server defines this URL.

sourceInstance

string

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

sourceInstanceParams

object (SourceInstanceParams)

The source instance params to use to create this instance template.

InstanceTemplateAggregatedList

Contains a list of InstanceTemplatesScopedList.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (InstanceTemplatesScopedList))

A list of InstanceTemplatesScopedList resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceTemplateList

A list of instance templates.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InstanceTemplate)

A list of InstanceTemplate resources.

kind

string

[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceTemplatesScopedList

(No description provided)
Fields
instanceTemplates[]

object (InstanceTemplate)

[Output Only] A list of instance templates that are contained within the specified project and zone.

warning

object

[Output Only] An informational warning that replaces the list of instance templates when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstanceWithNamedPorts

(No description provided)
Fields
instance

string

[Output Only] The URL of the instance.

namedPorts[]

object (NamedPort)

[Output Only] The named ports that belong to this instance group.

status

enum

[Output Only] The status of the instance.

Enum type. Can be one of the following:
DEPROVISIONING The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
PROVISIONING Resources are being allocated for the instance.
REPAIRING The instance is in repair.
RUNNING The instance is running.
STAGING All required resources have been allocated and the instance is being started.
STOPPED The instance has stopped successfully.
STOPPING The instance is currently stopping (either being deleted or killed).
SUSPENDED The instance has suspended.
SUSPENDING The instance is suspending.
TERMINATED The instance has stopped (either by explicit action or underlying failure).

InstancesAddResourcePoliciesRequest

(No description provided)
Fields
resourcePolicies[]

string

Resource policies to be added to this instance.

InstancesGetEffectiveFirewallsResponse

(No description provided)
Fields
firewallPolicys[]

object (InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy)

Effective firewalls from firewall policies.

firewalls[]

object (Firewall)

Effective firewalls on the instance.

InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy

(No description provided)
Fields
displayName

string

[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.

name

string

[Output Only] The name of the firewall policy.

rules[]

object (FirewallPolicyRule)

The rules that apply to the network.

shortName

string

[Output Only] The short name of the firewall policy.

type

enum

[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.

Enum type. Can be one of the following:
HIERARCHY (No description provided)
NETWORK (No description provided)
NETWORK_REGIONAL (No description provided)
UNSPECIFIED (No description provided)

InstancesRemoveResourcePoliciesRequest

(No description provided)
Fields
resourcePolicies[]

string

Resource policies to be removed from this instance.

InstancesScopedList

(No description provided)
Fields
instances[]

object (Instance)

[Output Only] A list of instances contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of instances when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InstancesSetLabelsRequest

(No description provided)
Fields
labelFingerprint

string (bytes format)

Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.

labels

map (key: string, value: string)

(No description provided)

InstancesSetMachineResourcesRequest

(No description provided)
Fields
guestAccelerators[]

object (AcceleratorConfig)

A list of the type and count of accelerator cards attached to the instance.

InstancesSetMachineTypeRequest

(No description provided)
Fields
machineType

string

Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1

InstancesSetMinCpuPlatformRequest

(No description provided)
Fields
minCpuPlatform

string

Minimum cpu/platform this instance should be started at.

InstancesSetNameRequest

(No description provided)
Fields
currentName

string

The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

name

string

The name to be applied to the instance. Needs to be RFC 1035 compliant.

InstancesSetServiceAccountRequest

(No description provided)
Fields
email

string

Email address of the service account.

scopes[]

string

The list of scopes to be made available for this service account.

InstancesStartWithEncryptionKeyRequest

(No description provided)
Fields
disks[]

object (CustomerEncryptionKeyProtectedDisk)

Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.

Int64RangeMatch

HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.
Fields
rangeEnd

string (int64 format)

The end of the range (exclusive) in signed long integer format.

rangeStart

string (int64 format)

The start of the range (inclusive) in signed long integer format.

Interconnect

Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.
Fields
adminEnabled

boolean

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

circuitInfos[]

object (InterconnectCircuitInfo)

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

customerName

string

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

description

string

An optional description of this resource. Provide this property when you create the resource.

expectedOutages[]

object (InterconnectOutageNotification)

[Output Only] A list of outages expected for this Interconnect.

googleIpAddress

string

[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

googleReferenceId

string

[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

interconnectAttachments[]

string

[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

interconnectType

enum

Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

Enum type. Can be one of the following:
DEDICATED A dedicated physical interconnection with the customer.
IT_PRIVATE [Deprecated] A private, physical interconnection with the customer.
PARTNER A partner-managed interconnection shared between customers via partner.
kind

string

[Output Only] Type of the resource. Always compute#interconnect for interconnects.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

linkType

enum

Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

Enum type. Can be one of the following:
LINK_TYPE_ETHERNET_100G_LR 100G Ethernet, LR Optics.
LINK_TYPE_ETHERNET_10G_LR 10G Ethernet, LR Optics. [(rate_bps) = 10000000000];
location

string

URL of the InterconnectLocation object that represents where this connection is to be provisioned.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

nocContactEmail

string

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

operationalStatus

enum

[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

Enum type. Can be one of the following:
OS_ACTIVE The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.
OS_UNPROVISIONED The interconnect has not completed turnup. No attachments may be provisioned on this interconnect.
peerIpAddress

string

[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.

provisionedLinkCount

integer (int32 format)

[Output Only] Number of links actually provisioned in this interconnect.

remoteLocation

string

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

requestedLinkCount

integer (int32 format)

Target number of physical links in the link bundle, as requested by the customer.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

selfLink

string

[Output Only] Server-defined URL for the resource.

state

enum

[Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

Enum type. Can be one of the following:
ACTIVE The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.
UNPROVISIONED The interconnect has not completed turnup. No attachments may be provisioned on this interconnect.

InterconnectAttachment

Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments.
Fields
adminEnabled

boolean

Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

bandwidth

enum

Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s

Enum type. Can be one of the following:
BPS_100M 100 Mbit/s
BPS_10G 10 Gbit/s
BPS_1G 1 Gbit/s
BPS_200M 200 Mbit/s
BPS_20G 20 Gbit/s
BPS_2G 2 Gbit/s
BPS_300M 300 Mbit/s
BPS_400M 400 Mbit/s
BPS_500M 500 Mbit/s
BPS_50G 50 Gbit/s
BPS_50M 50 Mbit/s
BPS_5G 5 Gbit/s
candidateIpv6Subnets[]

string

This field is not available.

candidateSubnets[]

string

Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

cloudRouterIpAddress

string

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

cloudRouterIpv6Address

string

[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

cloudRouterIpv6InterfaceId

string

This field is not available.

configurationConstraints

object (InterconnectAttachmentConfigurationConstraints)

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

customerRouterIpAddress

string

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

customerRouterIpv6Address

string

[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

customerRouterIpv6InterfaceId

string

This field is not available.

dataplaneVersion

integer (int32 format)

[Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.

description

string

An optional description of this resource.

edgeAvailabilityDomain

enum

Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.

Enum type. Can be one of the following:
AVAILABILITY_DOMAIN_1 (No description provided)
AVAILABILITY_DOMAIN_2 (No description provided)
AVAILABILITY_DOMAIN_ANY (No description provided)
encryption

enum

Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use HA VPN over Cloud Interconnect, the VLAN attachment must be created with this option.

Enum type. Can be one of the following:
IPSEC The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.
NONE This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment.
googleReferenceId

string

[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

interconnect

string

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

ipsecInternalAddresses[]

string

A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.

kind

string

[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

mtu

integer (int32 format)

Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

operationalStatus

enum

[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

Enum type. Can be one of the following:
OS_ACTIVE Indicates that attachment has been turned up and is ready to use.
OS_UNPROVISIONED Indicates that attachment is not ready to use yet, because turnup is not complete.
pairingKey

string

[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"

partnerAsn

string (int64 format)

Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.

partnerMetadata

object (InterconnectAttachmentPartnerMetadata)

Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

privateInterconnectInfo

object (InterconnectAttachmentPrivateInfo)

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

region

string

[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

remoteService

string

[Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.

router

string

URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

selfLink

string

[Output Only] Server-defined URL for the resource.

stackType

enum

The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.

Enum type. Can be one of the following:
IPV4_IPV6 The interconnect attachment can have both IPv4 and IPv6 addresses.
IPV4_ONLY The interconnect attachment will only be assigned IPv4 addresses.
state

enum

[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.

Enum type. Can be one of the following:
ACTIVE Indicates that attachment has been turned up and is ready to use.
DEFUNCT The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was wiped out, or because the other side of a Partner attachment was deleted.
PARTNER_REQUEST_RECEIVED A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
PENDING_CUSTOMER PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer to activate.
PENDING_PARTNER A newly created PARTNER attachment that has not yet been configured on the Partner side.
STATE_UNSPECIFIED (No description provided)
UNPROVISIONED Indicates that attachment is not ready to use yet, because turnup is not complete.
subnetLength

integer (int32 format)

Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.

type

enum

The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.

Enum type. Can be one of the following:
DEDICATED Attachment to a dedicated interconnect.
PARTNER Attachment to a partner interconnect, created by the customer.
PARTNER_PROVIDER Attachment to a partner interconnect, created by the partner.
vlanTag8021q

integer (int32 format)

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

InterconnectAttachmentAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (InterconnectAttachmentsScopedList))

A list of InterconnectAttachmentsScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InterconnectAttachmentConfigurationConstraints

(No description provided)
Fields
bgpMd5

enum

[Output Only] Whether the attachment's BGP session requires/allows/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachment_configuration_constraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested.

Enum type. Can be one of the following:
MD5_OPTIONAL MD5_OPTIONAL: BGP MD5 authentication is supported and can optionally be configured.
MD5_REQUIRED MD5_REQUIRED: BGP MD5 authentication must be configured.
MD5_UNSUPPORTED MD5_UNSUPPORTED: BGP MD5 authentication must not be configured
bgpPeerAsnRanges[]

object (InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange)

[Output Only] List of ASN ranges that the remote location is known to support. Formatted as an array of inclusive ranges {min: min-value, max: max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything in the range 64512-65534. This field is only advisory. Although the API accepts other ranges, these are the ranges that we recommend.

InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange

(No description provided)
Fields
max

integer (uint32 format)

(No description provided)

min

integer (uint32 format)

(No description provided)

InterconnectAttachmentList

Response to the list request, and contains a list of interconnect attachments.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InterconnectAttachment)

A list of InterconnectAttachment resources.

kind

string

[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InterconnectAttachmentPartnerMetadata

Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.
Fields
interconnectName

string

Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.

partnerName

string

Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.

portalUrl

string

URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.

InterconnectAttachmentPrivateInfo

Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.
Fields
tag8021q

integer (uint32 format)

[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.

InterconnectAttachmentsScopedList

(No description provided)
Fields
interconnectAttachments[]

object (InterconnectAttachment)

A list of interconnect attachments contained in this scope.

warning

object

Informational warning which replaces the list of addresses when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InterconnectCircuitInfo

Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.
Fields
customerDemarcId

string

Customer-side demarc ID for this circuit.

googleCircuitId

string

Google-assigned unique ID for this circuit. Assigned at circuit turn-up.

googleDemarcId

string

Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.

InterconnectDiagnostics

Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google's side of the connection.
Fields
arpCaches[]

object (InterconnectDiagnosticsARPEntry)

A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.

bundleAggregationType

enum

The aggregation type of the bundle interface.

Enum type. Can be one of the following:
BUNDLE_AGGREGATION_TYPE_LACP LACP is enabled.
BUNDLE_AGGREGATION_TYPE_STATIC LACP is disabled.
bundleOperationalStatus

enum

The operational status of the bundle interface.

Enum type. Can be one of the following:
BUNDLE_OPERATIONAL_STATUS_DOWN If bundleAggregationType is LACP: LACP is not established and/or all links in the bundle have DOWN operational status. If bundleAggregationType is STATIC: one or more links in the bundle has DOWN operational status.
BUNDLE_OPERATIONAL_STATUS_UP If bundleAggregationType is LACP: LACP is established and at least one link in the bundle has UP operational status. If bundleAggregationType is STATIC: all links in the bundle (typically just one) have UP operational status.
links[]

object (InterconnectDiagnosticsLinkStatus)

A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.

macAddress

string

The MAC address of the Interconnect's bundle interface.

InterconnectDiagnosticsARPEntry

Describing the ARP neighbor entries seen on this link
Fields
ipAddress

string

The IP address of this ARP neighbor.

macAddress

string

The MAC address of this ARP neighbor.

InterconnectDiagnosticsLinkLACPStatus

(No description provided)
Fields
googleSystemId

string

System ID of the port on Google's side of the LACP exchange.

neighborSystemId

string

System ID of the port on the neighbor's side of the LACP exchange.

state

enum

The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty.

Enum type. Can be one of the following:
ACTIVE The link is configured and active within the bundle.
DETACHED The link is not configured within the bundle, this means the rest of the object should be empty.

InterconnectDiagnosticsLinkOpticalPower

(No description provided)
Fields
state

enum

The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold.

Enum type. Can be one of the following:
HIGH_ALARM The value has crossed above the high alarm threshold.
HIGH_WARNING The value of the current optical power has crossed above the high warning threshold.
LOW_ALARM The value of the current optical power has crossed below the low alarm threshold.
LOW_WARNING The value of the current optical power has crossed below the low warning threshold.
OK The value of the current optical power has not crossed a warning threshold.
value

number (float format)

Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.

InterconnectDiagnosticsLinkStatus

(No description provided)
Fields
arpCaches[]

object (InterconnectDiagnosticsARPEntry)

A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled

circuitId

string

The unique ID for this link assigned during turn up by Google.

googleDemarc

string

The Demarc address assigned by Google and provided in the LoA.

lacpStatus

object (InterconnectDiagnosticsLinkLACPStatus)

(No description provided)

operationalStatus

enum

The operational status of the link.

Enum type. Can be one of the following:
LINK_OPERATIONAL_STATUS_DOWN The interface is unable to communicate with the remote end.
LINK_OPERATIONAL_STATUS_UP The interface has low level communication with the remote end.
receivingOpticalPower

object (InterconnectDiagnosticsLinkOpticalPower)

An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.

transmittingOpticalPower

object (InterconnectDiagnosticsLinkOpticalPower)

An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level.

InterconnectList

Response to the list request, and contains a list of interconnects.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Interconnect)

A list of Interconnect resources.

kind

string

[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InterconnectLocation

Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
Fields
address

string

[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.

availabilityZone

string

[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2".

city

string

[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".

continent

enum

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA

Enum type. Can be one of the following:
AFRICA (No description provided)
ASIA_PAC (No description provided)
C_AFRICA (No description provided)
C_ASIA_PAC (No description provided)
C_EUROPE (No description provided)
C_NORTH_AMERICA (No description provided)
C_SOUTH_AMERICA (No description provided)
EUROPE (No description provided)
NORTH_AMERICA (No description provided)
SOUTH_AMERICA (No description provided)
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

[Output Only] An optional description of the resource.

facilityProvider

string

[Output Only] The name of the provider for this facility (e.g., EQUINIX).

facilityProviderFacilityId

string

[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.

name

string

[Output Only] Name of the resource.

peeringdbFacilityId

string

[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).

regionInfos[]

object (InterconnectLocationRegionInfo)

[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.

selfLink

string

[Output Only] Server-defined URL for the resource.

status

enum

[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.

Enum type. Can be one of the following:
AVAILABLE The InterconnectLocation is available for provisioning new Interconnects.
CLOSED The InterconnectLocation is closed for provisioning new Interconnects.
supportsPzs

boolean

[Output Only] Reserved for future use.

InterconnectLocationList

Response to the list request, and contains a list of interconnect locations.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InterconnectLocation)

A list of InterconnectLocation resources.

kind

string

[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InterconnectLocationRegionInfo

Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
Fields
expectedRttMs

string (int64 format)

Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.

locationPresence

enum

Identifies the network presence of this location.

Enum type. Can be one of the following:
GLOBAL This region is not in any common network presence with this InterconnectLocation.
LOCAL_REGION This region shares the same regional network presence as this InterconnectLocation.
LP_GLOBAL [Deprecated] This region is not in any common network presence with this InterconnectLocation.
LP_LOCAL_REGION [Deprecated] This region shares the same regional network presence as this InterconnectLocation.
region

string

URL for the region of this location.

InterconnectOutageNotification

Description of a planned outage on this Interconnect.
Fields
affectedCircuits[]

string

If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.

description

string

A description about the purpose of the outage.

endTime

string (int64 format)

Scheduled end time for the outage (milliseconds since Unix epoch).

issueType

enum

Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.

Enum type. Can be one of the following:
IT_OUTAGE [Deprecated] The Interconnect may be completely out of service for some or all of the specified window.
IT_PARTIAL_OUTAGE [Deprecated] Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.
OUTAGE The Interconnect may be completely out of service for some or all of the specified window.
PARTIAL_OUTAGE Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.
name

string

Unique identifier for this outage notification.

source

enum

The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.

Enum type. Can be one of the following:
GOOGLE This notification was generated by Google.
NSRC_GOOGLE [Deprecated] This notification was generated by Google.
startTime

string (int64 format)

Scheduled start time for the outage (milliseconds since Unix epoch).

state

enum

State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.

Enum type. Can be one of the following:
ACTIVE This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.
CANCELLED The outage associated with this notification was cancelled before the outage was due to start.
COMPLETED The outage associated with this notification is complete.
NS_ACTIVE [Deprecated] This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.
NS_CANCELED [Deprecated] The outage associated with this notification was canceled before the outage was due to start.

InterconnectRemoteLocation

Represents a Cross-Cloud Interconnect Remote Location resource. You can use this resource to find remote location details about an Interconnect attachment (VLAN).
Fields
address

string

[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.

attachmentConfigurationConstraints

object (InterconnectAttachmentConfigurationConstraints)

[Output Only] Subset of fields from InterconnectAttachment's |configurationConstraints| field that apply to all attachments for this remote location.

city

string

[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".

constraints

object (InterconnectRemoteLocationConstraints)

[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments.

continent

enum

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA

Enum type. Can be one of the following:
AFRICA (No description provided)
ASIA_PAC (No description provided)
EUROPE (No description provided)
NORTH_AMERICA (No description provided)
SOUTH_AMERICA (No description provided)
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

[Output Only] An optional description of the resource.

facilityProvider

string

[Output Only] The name of the provider for this facility (e.g., EQUINIX).

facilityProviderFacilityId

string

[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations.

lacp

enum

[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED

Enum type. Can be one of the following:
LACP_SUPPORTED LACP_SUPPORTED: LACP is supported, and enabled by default on the Cross-Cloud Interconnect.
LACP_UNSUPPORTED LACP_UNSUPPORTED: LACP is not supported and is not be enabled on this port. GetDiagnostics shows bundleAggregationType as "static". GCP does not support LAGs without LACP, so requestedLinkCount must be 1.
maxLagSize100Gbps

integer (int32 format)

[Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.

maxLagSize10Gbps

integer (int32 format)

[Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.

name

string

[Output Only] Name of the resource.

peeringdbFacilityId

string

[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).

permittedConnections[]

object (InterconnectRemoteLocationPermittedConnections)

[Output Only] Permitted connections.

remoteService

string

[Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure".

selfLink

string

[Output Only] Server-defined URL for the resource.

status

enum

[Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects.

Enum type. Can be one of the following:
AVAILABLE The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects.
CLOSED The InterconnectRemoteLocation is closed for provisioning new Cross-Cloud Interconnects.

InterconnectRemoteLocationConstraints

(No description provided)
Fields
portPairRemoteLocation

enum

[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. GCP's API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.

Enum type. Can be one of the following:
PORT_PAIR_MATCHING_REMOTE_LOCATION If PORT_PAIR_MATCHING_REMOTE_LOCATION, the remote cloud provider allocates ports in pairs, and the user should choose the same remote location for both ports.
PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION If PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, a user may opt to provision a redundant pair of Cross-Cloud Interconnects using two different remote locations in the same city.
portPairVlan

enum

[Output Only] Port pair VLAN constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN

Enum type. Can be one of the following:
PORT_PAIR_MATCHING_VLAN If PORT_PAIR_MATCHING_VLAN, the Interconnect for this attachment is part of a pair of ports that should have matching VLAN allocations. This occurs with Cross-Cloud Interconnect to Azure remote locations. While GCP's API does not explicitly group pairs of ports, the UI uses this field to ensure matching VLAN ids when configuring a redundant VLAN pair.
PORT_PAIR_UNCONSTRAINED_VLAN PORT_PAIR_UNCONSTRAINED_VLAN means there is no constraint.
subnetLengthRange

object (InterconnectRemoteLocationConstraintsSubnetLengthRange)

[Output Only] [min-length, max-length] The minimum and maximum value (inclusive) for the IPv4 subnet length. For example, an interconnectRemoteLocation for Azure has {min: 30, max: 30} because Azure requires /30 subnets. This range specifies the values supported by both cloud providers. Interconnect currently supports /29 and /30 IPv4 subnet lengths. If a remote cloud has no constraint on IPv4 subnet length, the range would thus be {min: 29, max: 30}.

InterconnectRemoteLocationConstraintsSubnetLengthRange

(No description provided)
Fields
max

integer (int32 format)

(No description provided)

min

integer (int32 format)

(No description provided)

InterconnectRemoteLocationList

Response to the list request, and contains a list of interconnect remote locations.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InterconnectRemoteLocation)

A list of InterconnectRemoteLocation resources.

kind

string

[Output Only] Type of resource. Always compute#interconnectRemoteLocationList for lists of interconnect remote locations.

nextPageToken

string

[Output Only] This token lets you get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

InterconnectRemoteLocationPermittedConnections

(No description provided)
Fields
interconnectLocation

string

[Output Only] URL of an Interconnect location that is permitted to connect to this Interconnect remote location.

InterconnectsGetDiagnosticsResponse

Response for the InterconnectsGetDiagnosticsRequest.
Fields
result

object (InterconnectDiagnostics)

(No description provided)

License

Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.
Fields
chargesUseFee

boolean

[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional textual description of the resource; provided by the client when the resource is created.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of resource. Always compute#license for licenses.

licenseCode

string (uint64 format)

[Output Only] The unique code used to attach this license to images, snapshots, and disks.

name

string

Name of the resource. The name must be 1-63 characters long and comply with RFC1035.

resourceRequirements

object (LicenseResourceRequirements)

(No description provided)

selfLink

string

[Output Only] Server-defined URL for the resource.

transferable

boolean

If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.

LicenseCode

Represents a License Code resource. A License Code is a unique identifier used to represent a license resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

[Output Only] Description of this License Code.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of resource. Always compute#licenseCode for licenses.

licenseAlias[]

object (LicenseCodeLicenseAlias)

[Output Only] URL and description aliases of Licenses with the same License Code.

name

string

[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.

selfLink

string

[Output Only] Server-defined URL for the resource.

state

enum

[Output Only] Current state of this License Code.

Enum type. Can be one of the following:
DISABLED Machines are not allowed to attach boot disks with this License Code. Requests to create new resources with this license will be rejected.
ENABLED Use is allowed for anyone with USE_READ_ONLY access to this License Code.
RESTRICTED Use of this license is limited to a project whitelist.
STATE_UNSPECIFIED (No description provided)
TERMINATED Reserved state.
transferable

boolean

[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.

LicenseCodeLicenseAlias

(No description provided)
Fields
description

string

[Output Only] Description of this License Code.

selfLink

string

[Output Only] URL of license corresponding to this License Code.

LicenseResourceCommitment

Commitment for a particular license resource.
Fields
amount

string (int64 format)

The number of licenses purchased.

coresPerLicense

string

Specifies the core range of the instance for which this license applies.

license

string

Any applicable license URI.

LicenseResourceRequirements

(No description provided)
Fields
minGuestCpuCount

integer (int32 format)

Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.

minMemoryMb

integer (int32 format)

Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.

LicensesListResponse

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (License)

A list of License resources.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

LocalDisk

(No description provided)
Fields
diskCount

integer (int32 format)

Specifies the number of such disks.

diskSizeGb

integer (int32 format)

Specifies the size of the disk in base-2 GB.

diskType

string

Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL.

LocalizedMessage

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
Fields
locale

string

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"

message

string

The localized error message in the above locale.

LocationPolicy

Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).
Fields
locations

map (key: string, value: object (LocationPolicyLocation))

Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.

targetShape

enum

Strategy for distributing VMs across zones in a region.

Enum type. Can be one of the following:
ANY GCE picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.
ANY_SINGLE_ZONE GCE always selects a single zone for all the VMs, optimizing for resource quotas, available reservations and general capacity. Recommended for batch workloads that cannot tollerate distribution over multiple zones. This the default shape in Bulk Insert and Capacity Advisor APIs.
BALANCED GCE prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across allowed zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.

LocationPolicyLocation

(No description provided)
Fields
constraints

object (LocationPolicyLocationConstraints)

Constraints that the caller requires on the result distribution in this zone.

preference

enum

Preference for a given location. Set to either ALLOW or DENY.

Enum type. Can be one of the following:
ALLOW Location is allowed for use.
DENY Location is prohibited.
PREFERENCE_UNSPECIFIED Default value, unused.

LocationPolicyLocationConstraints

Per-zone constraints on location policy for this zone.
Fields
maxCount

integer (int32 format)

Maximum number of items that are allowed to be placed in this zone. The value must be non-negative.

LogConfig

This is deprecated and has no effect. Do not use.
Fields
cloudAudit

object (LogConfigCloudAuditOptions)

This is deprecated and has no effect. Do not use.

counter

object (LogConfigCounterOptions)

This is deprecated and has no effect. Do not use.

dataAccess

object (LogConfigDataAccessOptions)

This is deprecated and has no effect. Do not use.

LogConfigCloudAuditOptions

This is deprecated and has no effect. Do not use.
Fields
authorizationLoggingOptions

object (AuthorizationLoggingOptions)

This is deprecated and has no effect. Do not use.

logName

enum

This is deprecated and has no effect. Do not use.

Enum type. Can be one of the following:
ADMIN_ACTIVITY This is deprecated and has no effect. Do not use.
DATA_ACCESS This is deprecated and has no effect. Do not use.
UNSPECIFIED_LOG_NAME This is deprecated and has no effect. Do not use.

LogConfigCounterOptions

This is deprecated and has no effect. Do not use.
Fields
customFields[]

object (LogConfigCounterOptionsCustomField)

This is deprecated and has no effect. Do not use.

field

string

This is deprecated and has no effect. Do not use.

metric

string

This is deprecated and has no effect. Do not use.

LogConfigCounterOptionsCustomField

This is deprecated and has no effect. Do not use.
Fields
name

string

This is deprecated and has no effect. Do not use.

value

string

This is deprecated and has no effect. Do not use.

LogConfigDataAccessOptions

This is deprecated and has no effect. Do not use.
Fields
logMode

enum

This is deprecated and has no effect. Do not use.

Enum type. Can be one of the following:
LOG_FAIL_CLOSED This is deprecated and has no effect. Do not use.
LOG_MODE_UNSPECIFIED This is deprecated and has no effect. Do not use.

MachineImage

Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.
Fields
creationTimestamp

string

[Output Only] The creation timestamp for this machine image in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

guestFlush

boolean

[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.

id

string (uint64 format)

[Output Only] A unique identifier for this machine image. The server defines this identifier.

instanceProperties

object (InstanceProperties)

[Output Only] Properties of source instance

instanceProperties.metadata.items.key

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.

instanceProperties.metadata.items.value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

kind

string

[Output Only] The resource type, which is always compute#machineImage for machine image.

machineImageEncryptionKey

object (CustomerEncryptionKey)

Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.

name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

savedDisks[]

object (SavedDisk)

An array of Machine Image specific properties for disks attached to the source instance

selfLink

string

[Output Only] The URL for this machine image. The server defines this URL.

sourceDiskEncryptionKeys[]

object (SourceDiskEncryptionKey)

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

sourceInstance

string

The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

sourceInstanceProperties

object (SourceInstanceProperties)

[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

status

enum

[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.

Enum type. Can be one of the following:
CREATING (No description provided)
DELETING (No description provided)
INVALID (No description provided)
READY (No description provided)
UPLOADING (No description provided)
storageLocations[]

string

The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

totalStorageBytes

string (int64 format)

[Output Only] Total size of the storage used by the machine image.

MachineImageList

A list of machine images.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (MachineImage)

A list of MachineImage resources.

kind

string

[Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

MachineType

Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.
Fields
accelerators[]

object

[Output Only] A list of accelerator configurations assigned to this machine type.

accelerators.guestAcceleratorCount

integer (int32 format)

Number of accelerator cards exposed to the guest.

accelerators.guestAcceleratorType

string

The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated

object (DeprecationStatus)

[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable.

description

string

[Output Only] An optional textual description of the resource.

guestCpus

integer (int32 format)

[Output Only] The number of virtual CPUs that are available to the instance.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

imageSpaceGb

integer (int32 format)

[Deprecated] This property is deprecated and will never be populated with any relevant values.

isSharedCpu

boolean

[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.

kind

string

[Output Only] The type of the resource. Always compute#machineType for machine types.

maximumPersistentDisks

integer (int32 format)

[Output Only] Maximum persistent disks allowed.

maximumPersistentDisksSizeGb

string (int64 format)

[Output Only] Maximum total persistent disks size (GB) allowed.

memoryMb

integer (int32 format)

[Output Only] The amount of physical memory available to the instance, defined in MB.

name

string

[Output Only] Name of the resource.

scratchDisks[]

object

[Output Only] A list of extended scratch disks assigned to the instance.

scratchDisks.diskGb

integer (int32 format)

Size of the scratch disk, defined in GB.

selfLink

string

[Output Only] Server-defined URL for the resource.

zone

string

[Output Only] The name of the zone where the machine type resides, such as us-central1-a.

MachineTypeAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (MachineTypesScopedList))

A list of MachineTypesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

MachineTypeList

Contains a list of machine types.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (MachineType)

A list of MachineType resources.

kind

string

[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

MachineTypesScopedList

(No description provided)
Fields
machineTypes[]

object (MachineType)

[Output Only] A list of machine types contained in this scope.

warning

object

[Output Only] An informational warning that appears when the machine types list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ManagedInstance

A Managed Instance resource.
Fields
currentAction

enum

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified.

Enum type. Can be one of the following:
ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.
DELETING The managed instance group is permanently deleting this instance.
NONE The managed instance group has not scheduled any actions for this instance.
RECREATING The managed instance group is recreating this instance.
REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
RESTARTING The managed instance group is restarting this instance.
RESUMING The managed instance group is resuming this instance.
STARTING The managed instance group is starting this instance.
STOPPING The managed instance group is stopping this instance.
SUSPENDING The managed instance group is suspending this instance.
VERIFYING The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions).
id

string (uint64 format)

[Output only] The unique identifier for this resource. This field is empty when instance does not exist.

instance

string

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

instanceHealth[]

object (ManagedInstanceInstanceHealth)

[Output Only] Health state of the instance per health-check.

instanceStatus

enum

[Output Only] The status of the instance. This field is empty when the instance does not exist.

Enum type. Can be one of the following:
DEPROVISIONING The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
PROVISIONING Resources are being allocated for the instance.
REPAIRING The instance is in repair.
RUNNING The instance is running.
STAGING All required resources have been allocated and the instance is being started.
STOPPED The instance has stopped successfully.
STOPPING The instance is currently stopping (either being deleted or killed).
SUSPENDED The instance has suspended.
SUSPENDING The instance is suspending.
TERMINATED The instance has stopped (either by explicit action or underlying failure).
lastAttempt

object (ManagedInstanceLastAttempt)

[Output Only] Information about the last attempt to create or delete the instance.

lastAttempt.errors.errors[]

object

[Output Only] The array of errors encountered while processing this operation.

lastAttempt.errors.errors.code

string

[Output Only] The error type identifier for this error.

lastAttempt.errors.errors.errorDetails[]

object

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.

lastAttempt.errors.errors.errorDetails.errorInfo

object (ErrorInfo)

(No description provided)

lastAttempt.errors.errors.errorDetails.help

object (Help)

(No description provided)

lastAttempt.errors.errors.errorDetails.localizedMessage

object (LocalizedMessage)

(No description provided)

lastAttempt.errors.errors.errorDetails.quotaInfo

object (QuotaExceededInfo)

(No description provided)

lastAttempt.errors.errors.location

string

[Output Only] Indicates the field in the request that caused the error. This property is optional.

lastAttempt.errors.errors.message

string

[Output Only] An optional, human-readable error message.

preservedStateFromConfig

object (PreservedState)

[Output Only] Preserved state applied from per-instance config for this instance.

preservedStateFromPolicy

object (PreservedState)

[Output Only] Preserved state generated based on stateful policy for this instance.

version

object (ManagedInstanceVersion)

[Output Only] Intended version of this instance.

ManagedInstanceInstanceHealth

(No description provided)
Fields
detailedHealthState

enum

[Output Only] The current detailed instance health state.

Enum type. Can be one of the following:
DRAINING The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.
HEALTHY The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.
TIMEOUT The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.
UNHEALTHY The instance is reachable, but does not conform to the requirements defined by the health check.
UNKNOWN The health checking system is aware of the instance but its health is not known at the moment.
healthCheck

string

[Output Only] The URL for the health check that verifies whether the instance is healthy.

ManagedInstanceLastAttempt

(No description provided)
Fields
errors

object

[Output Only] Encountered errors during the last attempt to create or delete the instance.

errors.errors[]

object

[Output Only] The array of errors encountered while processing this operation.

errors.errors.code

string

[Output Only] The error type identifier for this error.

errors.errors.errorDetails[]

object

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.

errors.errors.errorDetails.errorInfo

object (ErrorInfo)

(No description provided)

errors.errors.errorDetails.help

object (Help)

(No description provided)

errors.errors.errorDetails.localizedMessage

object (LocalizedMessage)

(No description provided)

errors.errors.errorDetails.quotaInfo

object (QuotaExceededInfo)

(No description provided)

errors.errors.location

string

[Output Only] Indicates the field in the request that caused the error. This property is optional.

errors.errors.message

string

[Output Only] An optional, human-readable error message.

ManagedInstanceVersion

(No description provided)
Fields
instanceTemplate

string

[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

name

string

[Output Only] Name of the version.

Metadata

A metadata key/value entry.
Fields
fingerprint

string (bytes format)

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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.

items[]

object

Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

items.key

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.

items.value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

kind

string

[Output Only] Type of the resource. Always compute#metadata for metadata.

MetadataFilter

Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.
Fields
filterLabels[]

object (MetadataFilterLabelMatch)

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

filterMatchCriteria

enum

Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.

Enum type. Can be one of the following:
MATCH_ALL Specifies that all filterLabels must match for the metadataFilter to be considered a match.
MATCH_ANY Specifies that any filterLabel must match for the metadataFilter to be considered a match.
NOT_SET Indicates that the match criteria was not set. A metadataFilter must never be created with this value.

MetadataFilterLabelMatch

MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer.
Fields
name

string

Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

value

string

The value of the label must match the specified value. value can have a maximum length of 1024 characters.

NamedPort

The named port. For example: <"http", 80>.
Fields
name

string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port

integer (int32 format)

The port number, which can be a value between 1 and 65535.

NatIpInfo

Contains NAT IP information of a NAT config (i.e. usage status, mode).
Fields
natIpInfoMappings[]

object (NatIpInfoNatIpInfoMapping)

A list of all NAT IPs assigned to this NAT config.

natName

string

Name of the NAT config which the NAT IP belongs to.

NatIpInfoNatIpInfoMapping

Contains information of a NAT IP.
Fields
mode

enum

Specifies whether NAT IP is auto or manual.

Enum type. Can be one of the following:
AUTO (No description provided)
MANUAL (No description provided)
natIp

string

NAT IP address. For example: 203.0.113.11.

usage

enum

Specifies whether NAT IP is currently serving at least one endpoint or not.

Enum type. Can be one of the following:
IN_USE (No description provided)
UNUSED (No description provided)

NatIpInfoResponse

(No description provided)
Fields
result[]

object (NatIpInfo)

[Output Only] A list of NAT IP information.

Network

Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.
Fields
IPv4Range

string

Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.

autoCreateSubnetworks

boolean

Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this field when you create the resource.

enableUlaInternalIpv6

boolean

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .

firewallPolicy

string

[Output Only] URL of the firewall policy the network is associated with.

gatewayIPv4

string

[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

internalIpv6Range

string

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .

kind

string

[Output Only] Type of the resource. Always compute#network for networks.

mtu

integer (int32 format)

Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

networkFirewallPolicyEnforcementOrder

enum

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.

Enum type. Can be one of the following:
AFTER_CLASSIC_FIREWALL (No description provided)
BEFORE_CLASSIC_FIREWALL (No description provided)
peerings[]

object (NetworkPeering)

[Output Only] A list of network peerings for the resource.

routingConfig

object (NetworkRoutingConfig)

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.

selfLink

string

[Output Only] Server-defined URL for the resource.

selfLinkWithId

string

[Output Only] Server-defined URL for this resource with the resource id.

subnetworks[]

string

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

NetworkAttachment

NetworkAttachments A network attachment resource ...
Fields
connectionEndpoints[]

object (NetworkAttachmentConnectedEndpoint)

[Output Only] An array of connections for all the producers connected to this network attachment.

connectionPreference

enum

(No description provided)

Enum type. Can be one of the following:
ACCEPT_AUTOMATIC (No description provided)
ACCEPT_MANUAL (No description provided)
INVALID (No description provided)
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.

id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.

kind

string

[Output Only] Type of the resource.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

string

[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.

producerAcceptLists[]

string

Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.

producerRejectLists[]

string

Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.

region

string

[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

selfLinkWithId

string

[Output Only] Server-defined URL for this resource's resource id.

subnetworks[]

string

An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.

NetworkAttachmentAggregatedList

Contains a list of NetworkAttachmentsScopedList.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (NetworkAttachmentsScopedList))

A list of NetworkAttachmentsScopedList resources.

kind

string

(No description provided)

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkAttachmentConnectedEndpoint

[Output Only] A connection connected to this network attachment.
Fields
ipAddress

string

The IPv4 address assigned to the producer instance network interface. This value will be a range in case of Serverless.

projectIdOrNum

string

The project id or number of the interface to which the IP was assigned.

secondaryIpCidrRanges[]

string

Alias IP ranges from the same subnetwork.

status

enum

The status of a connected endpoint to this network attachment.

Enum type. Can be one of the following:
ACCEPTED The consumer allows traffic from the producer to reach its VPC.
CLOSED The consumer network attachment no longer exists.
NEEDS_ATTENTION The consumer needs to take further action before traffic can be served.
PENDING The consumer neither allows nor prohibits traffic from the producer to reach its VPC.
REJECTED The consumer prohibits traffic from the producer to reach its VPC.
STATUS_UNSPECIFIED (No description provided)
subnetwork

string

The subnetwork used to assign the IP to the producer instance network interface.

NetworkAttachmentList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (NetworkAttachment)

A list of NetworkAttachment resources.

kind

string

(No description provided)

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkAttachmentsScopedList

(No description provided)
Fields
networkAttachments[]

object (NetworkAttachment)

A list of NetworkAttachments contained in this scope.

warning

object

Informational warning which replaces the list of network attachments when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkEdgeSecurityService

Represents a Google Cloud Armor network edge security service resource.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region

string

[Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

securityPolicy

string

The resource URL for the network edge security service associated with this network edge security service.

selfLink

string

[Output Only] Server-defined URL for the resource.

selfLinkWithId

string

[Output Only] Server-defined URL for this resource with the resource id.

NetworkEdgeSecurityServiceAggregatedList

(No description provided)
Fields
etag

string

(No description provided)

id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (NetworkEdgeSecurityServicesScopedList))

A list of NetworkEdgeSecurityServicesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkEdgeSecurityServicesScopedList

(No description provided)
Fields
networkEdgeSecurityServices[]

object (NetworkEdgeSecurityService)

A list of NetworkEdgeSecurityServices contained in this scope.

warning

object

Informational warning which replaces the list of security policies when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkEndpoint

The network endpoint.
Fields
annotations

map (key: string, value: string)

Metadata defined as annotations on the network endpoint.

fqdn

string

Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.

instance

string

The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035.

ipAddress

string

Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.

port

integer (int32 format)

Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.

NetworkEndpointGroup

Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs.
Fields
annotations

map (key: string, value: string)

Metadata defined as annotations on the network endpoint group.

appEngine

object (NetworkEndpointGroupAppEngine)

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

cloudFunction

object (NetworkEndpointGroupCloudFunction)

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

cloudRun

object (NetworkEndpointGroupCloudRun)

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

defaultPort

integer (int32 format)

The default port used if the port number is not specified in the network endpoint.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

string

The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.

networkEndpointType

enum

Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT.

Enum type. Can be one of the following:
GCE_VM_IP The network endpoint is represented by an IP address.
GCE_VM_IP_PORT The network endpoint is represented by IP address and port pair.
INTERNET_FQDN_PORT The network endpoint is represented by fully qualified domain name and port.
INTERNET_IP_PORT The network endpoint is represented by an internet IP address and port.
NON_GCP_PRIVATE_IP_PORT The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.
PRIVATE_SERVICE_CONNECT The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect
SERVERLESS The network endpoint is handled by specified serverless infrastructure.
pscData

object (NetworkEndpointGroupPscData)

(No description provided)

pscTargetService

string

The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com"

region

string

[Output Only] The URL of the region where the network endpoint group is located.

selfLink

string

[Output Only] Server-defined URL for the resource.

size

integer (int32 format)

[Output only] Number of network endpoints in the network endpoint group.

subnetwork

string

Optional URL of the subnetwork to which all network endpoints in the NEG belong.

zone

string

[Output Only] The URL of the zone where the network endpoint group is located.

NetworkEndpointGroupAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (NetworkEndpointGroupsScopedList))

A list of NetworkEndpointGroupsScopedList resources.

kind

string

[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkEndpointGroupAppEngine

Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.
Fields
service

string

Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: "default", "my-service".

urlMask

string

A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively.

version

string

Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: "v1", "v2".

NetworkEndpointGroupCloudFunction

Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.
Fields
function

string

A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: "func1".

urlMask

string

A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs " mydomain.com/function1" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively.

NetworkEndpointGroupCloudRun

Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.
Fields
service

string

Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service".

tag

string

Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010".

urlMask

string

A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively.

NetworkEndpointGroupList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (NetworkEndpointGroup)

A list of NetworkEndpointGroup resources.

kind

string

[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkEndpointGroupPscData

All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.
Fields
consumerPscAddress

string

[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.

pscConnectionId

string (uint64 format)

[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.

pscConnectionStatus

enum

[Output Only] The connection status of the PSC Forwarding Rule.

Enum type. Can be one of the following:
ACCEPTED The connection has been accepted by the producer.
CLOSED The connection has been closed by the producer and will not serve traffic going forward.
NEEDS_ATTENTION The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
PENDING The connection is pending acceptance by the producer.
REJECTED The connection has been rejected by the producer.
STATUS_UNSPECIFIED (No description provided)

NetworkEndpointGroupsAttachEndpointsRequest

(No description provided)
Fields
networkEndpoints[]

object (NetworkEndpoint)

The list of network endpoints to be attached.

NetworkEndpointGroupsDetachEndpointsRequest

(No description provided)
Fields
networkEndpoints[]

object (NetworkEndpoint)

The list of network endpoints to be detached.

NetworkEndpointGroupsListEndpointsRequest

(No description provided)
Fields
healthStatus

enum

Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.

Enum type. Can be one of the following:
SHOW Show the health status for each network endpoint. Impacts latency of the call.
SKIP Health status for network endpoints will not be provided.

NetworkEndpointGroupsListNetworkEndpoints

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (NetworkEndpointWithHealthStatus)

A list of NetworkEndpointWithHealthStatus resources.

kind

string

[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkEndpointGroupsScopedList

(No description provided)
Fields
networkEndpointGroups[]

object (NetworkEndpointGroup)

[Output Only] The list of network endpoint groups that are contained in this scope.

warning

object

[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkEndpointWithHealthStatus

(No description provided)
Fields
healths[]

object (HealthStatusForNetworkEndpoint)

[Output only] The health status of network endpoint;

networkEndpoint

object (NetworkEndpoint)

[Output only] The network endpoint;

NetworkInterface

A network interface resource attached to an instance.
Fields
accessConfigs[]

object (AccessConfig)

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

aliasIpRanges[]

object (AliasIpRange)

An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

fingerprint

string (bytes format)

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

internalIpv6PrefixLength

integer (int32 format)

The prefix length of the primary internal IPv6 range.

ipv6AccessConfigs[]

object (AccessConfig)

An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

ipv6AccessType

enum

[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.

Enum type. Can be one of the following:
EXTERNAL This network interface can have external IPv6.
INTERNAL This network interface can have internal IPv6.
ipv6Address

string

An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.

kind

string

[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

name

string

[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.

network

string

URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. 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

networkAttachment

string

The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.

networkIP

string

An IPv4 internal IP 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.

nicType

enum

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Enum type. Can be one of the following:
GVNIC GVNIC
UNSPECIFIED_NIC_TYPE No type specified.
VIRTIO_NET VIRTIO
queueCount

integer (int32 format)

The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

stackType

enum

The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.

Enum type. Can be one of the following:
IPV4_IPV6 The network interface can have both IPv4 and IPv6 addresses.
IPV4_ONLY The network interface will be assigned IPv4 address.
subnetwork

string

The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, 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/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

NetworkList

Contains a list of networks.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Network)

A list of Network resources.

kind

string

[Output Only] Type of resource. Always compute#networkList for lists of networks.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NetworkPeering

A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.
Fields
autoCreateRoutes

boolean

This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

exchangeSubnetRoutes

boolean

Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

exportCustomRoutes

boolean

Whether to export the custom routes to peer network. The default value is false.

exportSubnetRoutesWithPublicIp

boolean

Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.

importCustomRoutes

boolean

Whether to import the custom routes from peer network. The default value is false.

importSubnetRoutesWithPublicIp

boolean

Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.

name

string

Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

string

The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.

peerMtu

integer (int32 format)

Maximum Transmission Unit in bytes.

stackType

enum

Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.

Enum type. Can be one of the following:
IPV4_IPV6 This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
IPV4_ONLY This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
state

enum

[Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there's a matching configuration in the peer network.

Enum type. Can be one of the following:
ACTIVE Matching configuration exists on the peer.
INACTIVE There is no matching configuration on the peer, including the case when peer does not exist.
stateDetails

string

[Output Only] Details about the current state of the peering.

NetworkPerformanceConfig

(No description provided)
Fields
totalEgressBandwidthTier

enum

(No description provided)

Enum type. Can be one of the following:
DEFAULT (No description provided)
TIER_1 (No description provided)

NetworkRoutingConfig

A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.
Fields
routingMode

enum

The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.

Enum type. Can be one of the following:
GLOBAL (No description provided)
REGIONAL (No description provided)

NetworksAddPeeringRequest

(No description provided)
Fields
autoCreateRoutes

boolean

This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

name

string

Name of the peering, which should conform to RFC1035.

networkPeering

object (NetworkPeering)

Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon.

peerNetwork

string

URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.

NetworksGetEffectiveFirewallsResponse

(No description provided)
Fields
firewallPolicys[]

object (NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy)

Effective firewalls from firewall policy.

firewalls[]

object (Firewall)

Effective firewalls on the network.

NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy

(No description provided)
Fields
displayName

string

[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.

name

string

[Output Only] The name of the firewall policy.

rules[]

object (FirewallPolicyRule)

The rules that apply to the network.

shortName

string

[Output Only] The short name of the firewall policy.

type

enum

[Output Only] The type of the firewall policy.

Enum type. Can be one of the following:
HIERARCHY (No description provided)
NETWORK (No description provided)
UNSPECIFIED (No description provided)

NetworksRemovePeeringRequest

(No description provided)
Fields
name

string

Name of the peering, which should conform to RFC1035.

NetworksUpdatePeeringRequest

(No description provided)
Fields
networkPeering

object (NetworkPeering)

(No description provided)

NodeGroup

Represents a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
Fields
autoscalingPolicy

object (NodeGroupAutoscalingPolicy)

Specifies how autoscaling should behave.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

(No description provided)

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] The type of the resource. Always compute#nodeGroup for node group.

locationHint

string

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

maintenancePolicy

enum

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

Enum type. Can be one of the following:
DEFAULT Allow the node and corresponding instances to retain default maintenance behavior.
MAINTENANCE_POLICY_UNSPECIFIED (No description provided)
MIGRATE_WITHIN_NODE_GROUP When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
RESTART_IN_PLACE Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
maintenanceWindow

object (NodeGroupMaintenanceWindow)

(No description provided)

name

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

nodeTemplate

string

URL of the node template to create the node group from.

selfLink

string

[Output Only] Server-defined URL for the resource.

shareSettings

object (ShareSettings)

Share-settings for the node group

size

integer (int32 format)

[Output Only] The total number of nodes in the node group.

status

enum

(No description provided)

Enum type. Can be one of the following:
CREATING (No description provided)
DELETING (No description provided)
INVALID (No description provided)
READY (No description provided)
zone

string

[Output Only] The name of the zone where the node group resides, such as us-central1-a.

NodeGroupAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (NodeGroupsScopedList))

A list of NodeGroupsScopedList resources.

kind

string

[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeGroupAutoscalingPolicy

(No description provided)
Fields
maxNodes

integer (int32 format)

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

minNodes

integer (int32 format)

The minimum number of nodes that the group should have.

mode

enum

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

Enum type. Can be one of the following:
MODE_UNSPECIFIED (No description provided)
OFF Autoscaling is disabled.
ON Autocaling is fully enabled.
ONLY_SCALE_OUT Autoscaling will only scale out and will not remove nodes.

NodeGroupList

Contains a list of nodeGroups.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (NodeGroup)

A list of NodeGroup resources.

kind

string

[Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeGroupMaintenanceWindow

Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.
Fields
maintenanceDuration

object (Duration)

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

startTime

string

Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

NodeGroupNode

(No description provided)
Fields
accelerators[]

object (AcceleratorConfig)

Accelerators for this node.

consumedResources

object (InstanceConsumptionInfo)

Node resources that are reserved by all instances.

cpuOvercommitType

enum

CPU overcommit.

Enum type. Can be one of the following:
CPU_OVERCOMMIT_TYPE_UNSPECIFIED (No description provided)
ENABLED (No description provided)
NONE (No description provided)
disks[]

object (LocalDisk)

Local disk configurations.

instanceConsumptionData[]

object (InstanceConsumptionData)

Instance data that shows consumed resources on the node.

instances[]

string

Instances scheduled on this node.

name

string

The name of the node.

nodeType

string

The type of this node.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

serverBinding

object (ServerBinding)

Binding properties for the physical server.

serverId

string

Server ID associated with this node.

status

enum

(No description provided)

Enum type. Can be one of the following:
CREATING (No description provided)
DELETING (No description provided)
INVALID (No description provided)
READY (No description provided)
REPAIRING (No description provided)
totalResources

object (InstanceConsumptionInfo)

Total amount of available resources on the node.

NodeGroupsAddNodesRequest

(No description provided)
Fields
additionalNodeCount

integer (int32 format)

Count of additional nodes to be added to the node group.

NodeGroupsDeleteNodesRequest

(No description provided)
Fields
nodes[]

string

Names of the nodes to delete.

NodeGroupsListNodes

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (NodeGroupNode)

A list of Node resources.

kind

string

[Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeGroupsScopedList

(No description provided)
Fields
nodeGroups[]

object (NodeGroup)

[Output Only] A list of node groups contained in this scope.

warning

object

[Output Only] An informational warning that appears when the nodeGroup list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeGroupsSetNodeTemplateRequest

(No description provided)
Fields
nodeTemplate

string

Full or partial URL of the node template resource to be updated for this node group.

NodeGroupsSimulateMaintenanceEventRequest

(No description provided)
Fields
nodes[]

string

Names of the nodes to go under maintenance simulation.

NodeTemplate

Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances.
Fields
accelerators[]

object (AcceleratorConfig)

(No description provided)

cpuOvercommitType

enum

CPU overcommit.

Enum type. Can be one of the following:
CPU_OVERCOMMIT_TYPE_UNSPECIFIED (No description provided)
ENABLED (No description provided)
NONE (No description provided)
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

disks[]

object (LocalDisk)

(No description provided)

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.

name

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

nodeAffinityLabels

map (key: string, value: string)

Labels to use for node affinity, which will be used in instance scheduling.

nodeType

string

The node type to use for nodes group that are created from this template.

nodeTypeFlexibility

object (NodeTemplateNodeTypeFlexibility)

Do not use. Instead, use the node_type property.

region

string

[Output Only] The name of the region where the node template resides, such as us-central1.

selfLink

string

[Output Only] Server-defined URL for the resource.

serverBinding

object (ServerBinding)

Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information.

status

enum

[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING.

Enum type. Can be one of the following:
CREATING Resources are being allocated.
DELETING The node template is currently being deleted.
INVALID Invalid status.
READY The node template is ready.
statusMessage

string

[Output Only] An optional, human-readable explanation of the status.

NodeTemplateAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (NodeTemplatesScopedList))

A list of NodeTemplatesScopedList resources.

kind

string

[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeTemplateList

Contains a list of node templates.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (NodeTemplate)

A list of NodeTemplate resources.

kind

string

[Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeTemplateNodeTypeFlexibility

(No description provided)
Fields
cpus

string

(No description provided)

localSsd

string

(No description provided)

memory

string

(No description provided)

NodeTemplatesScopedList

(No description provided)
Fields
nodeTemplates[]

object (NodeTemplate)

[Output Only] A list of node templates contained in this scope.

warning

object

[Output Only] An informational warning that appears when the node templates list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeType

Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types.
Fields
cpuPlatform

string

[Output Only] The CPU platform used by this node type.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated

object (DeprecationStatus)

[Output Only] The deprecation status associated with this node type.

description

string

[Output Only] An optional textual description of the resource.

guestCpus

integer (int32 format)

[Output Only] The number of virtual CPUs that are available to the node type.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] The type of the resource. Always compute#nodeType for node types.

localSsdGb

integer (int32 format)

[Output Only] Local SSD available to the node type, defined in GB.

memoryMb

integer (int32 format)

[Output Only] The amount of physical memory available to the node type, defined in MB.

name

string

[Output Only] Name of the resource.

selfLink

string

[Output Only] Server-defined URL for the resource.

zone

string

[Output Only] The name of the zone where the node type resides, such as us-central1-a.

NodeTypeAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (NodeTypesScopedList))

A list of NodeTypesScopedList resources.

kind

string

[Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeTypeList

Contains a list of node types.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (NodeType)

A list of NodeType resources.

kind

string

[Output Only] Type of resource.Always compute#nodeTypeList for lists of node types.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NodeTypesScopedList

(No description provided)
Fields
nodeTypes[]

object (NodeType)

[Output Only] A list of node types contained in this scope.

warning

object

[Output Only] An informational warning that appears when the node types list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

NotificationEndpoint

Represents a notification endpoint. A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. For more information, see Health checks overview.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

grpcSettings

object (NotificationEndpointGrpcSettings)

Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.

id

string (uint64 format)

[Output Only] A unique identifier for this resource type. The server generates this identifier.

kind

string

[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region

string

[Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

NotificationEndpointGrpcSettings

Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint.
Fields
authority

string

Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3

endpoint

string

Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.

payloadName

string

Optional. If specified, this field is used to populate the "name" field in gRPC requests.

resendInterval

object (Duration)

Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. Can only be set for regional notification endpoints.

retryDurationSec

integer (uint32 format)

How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.

NotificationEndpointList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (NotificationEndpoint)

A list of NotificationEndpoint resources.

kind

string

[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

Operation

Represents an Operation resource. Google Compute Engine has three Operation resources: * Global * Regional * Zonal You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zoneOperations resource. For more information, read Global, Regional, and Zonal Resources.
Fields
clientOperationId

string

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

creationTimestamp

string

[Deprecated] This field is deprecated.

description

string

[Output Only] A textual description of the operation, which is set when the operation is created.

endTime

string

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

error

object

[Output Only] If errors are generated during processing of the operation, this field will be populated.

error.errors[]

object

[Output Only] The array of errors encountered while processing this operation.

error.errors.code

string

[Output Only] The error type identifier for this error.

error.errors.errorDetails[]

object

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.

error.errors.errorDetails.errorInfo

object (ErrorInfo)

(No description provided)

error.errors.errorDetails.help

object (Help)

(No description provided)

error.errors.errorDetails.localizedMessage

object (LocalizedMessage)

(No description provided)

error.errors.errorDetails.quotaInfo

object (QuotaExceededInfo)

(No description provided)

error.errors.location

string

[Output Only] Indicates the field in the request that caused the error. This property is optional.

error.errors.message

string

[Output Only] An optional, human-readable error message.

httpErrorMessage

string

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

httpErrorStatusCode

integer (int32 format)

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

id

string (uint64 format)

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

insertTime

string

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

kind

string

[Output Only] Type of the resource. Always compute#operation for Operation resources.

name

string

[Output Only] Name of the operation.

operationGroupId

string

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

operationType

string

[Output Only] The type of operation, such as insert, update, or delete, and so on.

progress

integer (int32 format)

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

region

string

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

selfLink

string

[Output Only] Server-defined URL for the resource.

setCommonInstanceMetadataOperationMetadata

object (SetCommonInstanceMetadataOperationMetadata)

[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.

startTime

string

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

status

enum

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

Enum type. Can be one of the following:
DONE (No description provided)
PENDING (No description provided)
RUNNING (No description provided)
statusMessage

string

[Output Only] An optional textual description of the current status of the operation.

targetId

string (uint64 format)

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

targetLink

string

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

user

string

[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).

warnings[]

object

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

warnings.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warnings.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warnings.data.key

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).

warnings.data.value

string

[Output Only] A warning data value corresponding to the key.

warnings.message

string

[Output Only] A human-readable description of the warning code.

zone

string

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

OperationAggregatedList

(No description provided)
Fields
id

string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items

map (key: string, value: object (OperationsScopedList))

[Output Only] A map of scoped operation lists.

kind

string

[Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

OperationList

Contains a list of Operation resources.
Fields
id

string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items[]

object (Operation)

[Output Only] A list of Operation resources.

kind

string

[Output Only] Type of resource. Always compute#operations for Operations resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

OperationsScopedList

(No description provided)
Fields
operations[]

object (Operation)

[Output Only] A list of operations contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of operations when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

OutlierDetection

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
Fields
baseEjectionTime

object (Duration)

The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.

consecutiveErrors

integer (int32 format)

Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

consecutiveGatewayFailure

integer (int32 format)

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

enforcingConsecutiveErrors

integer (int32 format)

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

enforcingConsecutiveGatewayFailure

integer (int32 format)

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

enforcingSuccessRate

integer (int32 format)

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.

interval

object (Duration)

Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.

maxEjectionPercent

integer (int32 format)

Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.

successRateMinimumHosts

integer (int32 format)

The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.

successRateRequestVolume

integer (int32 format)

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.

successRateStdevFactor

integer (int32 format)

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.

PacketIntervals

Next free: 7
Fields
avgMs

string (int64 format)

Average observed inter-packet interval in milliseconds.

duration

enum

From how long ago in the past these intervals were observed.

Enum type. Can be one of the following:
DURATION_UNSPECIFIED (No description provided)
HOUR (No description provided)
MAX From BfdSession object creation time.
MINUTE (No description provided)
maxMs

string (int64 format)

Maximum observed inter-packet interval in milliseconds.

minMs

string (int64 format)

Minimum observed inter-packet interval in milliseconds.

numIntervals

string (int64 format)

Number of inter-packet intervals from which these statistics were derived.

type

enum

The type of packets for which inter-packet intervals were computed.

Enum type. Can be one of the following:
LOOPBACK Only applies to Echo packets. This shows the intervals between sending and receiving the same packet.
RECEIVE Intervals between received packets.
TRANSMIT Intervals between transmitted packets.
TYPE_UNSPECIFIED (No description provided)

PacketMirroring

Represents a Packet Mirroring resource. Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring.
Fields
collectorIlb

object (PacketMirroringForwardingRuleInfo)

The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

enable

enum

Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE.

Enum type. Can be one of the following:
FALSE (No description provided)
TRUE (No description provided)
filter

object (PacketMirroringFilter)

Filter for mirrored traffic. If unspecified, all traffic is mirrored.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.

mirroredResources

object (PacketMirroringMirroredResourceInfo)

PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.

name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

object (PacketMirroringNetworkInfo)

Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.

priority

integer (uint32 format)

The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.

region

string

[Output Only] URI of the region where the packetMirroring resides.

selfLink

string

[Output Only] Server-defined URL for the resource.

PacketMirroringAggregatedList

Contains a list of packetMirrorings.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (PacketMirroringsScopedList))

A list of PacketMirroring resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

PacketMirroringFilter

(No description provided)
Fields
IPProtocols[]

string

Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.

cidrRanges[]

string

IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.

direction

enum

Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH.

Enum type. Can be one of the following:
BOTH Default, both directions are mirrored.
EGRESS Only egress traffic is mirrored.
INGRESS Only ingress traffic is mirrored.

PacketMirroringForwardingRuleInfo

(No description provided)
Fields
canonicalUrl

string

[Output Only] Unique identifier for the forwarding rule; defined by the server.

url

string

Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.

PacketMirroringList

Contains a list of PacketMirroring resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (PacketMirroring)

A list of PacketMirroring resources.

kind

string

[Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

PacketMirroringMirroredResourceInfo

(No description provided)
Fields
instances[]

object (PacketMirroringMirroredResourceInfoInstanceInfo)

A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring. Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring. You may specify a maximum of 50 Instances.

subnetworks[]

object (PacketMirroringMirroredResourceInfoSubnetInfo)

A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks.

tags[]

string

A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.

PacketMirroringMirroredResourceInfoInstanceInfo

(No description provided)
Fields
canonicalUrl

string

[Output Only] Unique identifier for the instance; defined by the server.

url

string

Resource URL to the virtual machine instance which is being mirrored.

PacketMirroringMirroredResourceInfoSubnetInfo

(No description provided)
Fields
canonicalUrl

string

[Output Only] Unique identifier for the subnetwork; defined by the server.

url

string

Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.

PacketMirroringNetworkInfo

(No description provided)
Fields
canonicalUrl

string

[Output Only] Unique identifier for the network; defined by the server.

url

string

URL of the network resource.

PacketMirroringsScopedList

(No description provided)
Fields
packetMirrorings[]

object (PacketMirroring)

A list of packetMirrorings contained in this scope.

warning

object

Informational warning which replaces the list of packetMirrorings when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

PathMatcher

A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.
Fields
defaultRouteAction

object (HttpRouteAction)

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.

defaultService

string

The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

defaultUrlRedirect

object (HttpRedirectAction)

When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

description

string

An optional description of this resource. Provide this property when you create the resource.

headerAction

object (HttpHeaderAction)

Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

name

string

The name to which this PathMatcher is referred by the HostRule.

pathRules[]

object (PathRule)

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/ will match before /a/b/ irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.

routeRules[]

object (HttpRouteRule)

The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.

PathRule

A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
Fields
paths[]

string

The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

routeAction

object (HttpRouteAction)

In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path rule's routeAction.

service

string

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

urlRedirect

object (HttpRedirectAction)

When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

PerInstanceConfig

(No description provided)
Fields
fingerprint

string (bytes format)

Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.

name

string

The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configconfiguration for a VM instance that either doesn't exist or is not part of the group will result in an error.

preservedState

object (PreservedState)

The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.

status

enum

The status of applying this per-instance configuration on the corresponding managed instance.

Enum type. Can be one of the following:
APPLYING The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.
DELETING The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.
EFFECTIVE The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.
NONE [Default] The default status, when no per-instance configuration exists.
UNAPPLIED The per-instance configuration is set on an instance but not been applied yet.
UNAPPLIED_DELETION The per-instance configuration has been deleted, but the deletion is not yet applied.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.
Fields
auditConfigs[]

object (AuditConfig)

Specifies cloud audit logging configuration for this policy.

bindings[]

object (Binding)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

etag

string (bytes format)

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

rules[]

object (Rule)

This is deprecated and has no effect. Do not use.

version

integer (int32 format)

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

PreconfiguredWafSet

(No description provided)
Fields
expressionSets[]

object (WafExpressionSet)

List of entities that are currently supported for WAF rules.

PreservedState

Preserved state for a given instance.
Fields
disks

map (key: string, value: object (PreservedStatePreservedDisk))

Preserved disks defined for this instance. This map is keyed with the device names of the disks.

metadata

map (key: string, value: string)

Preserved metadata defined for this instance.

PreservedStatePreservedDisk

(No description provided)
Fields
autoDelete

enum

These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.

Enum type. Can be one of the following:
NEVER (No description provided)
ON_PERMANENT_INSTANCE_DELETION (No description provided)
mode

enum

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.

Enum type. Can be one of the following:
READ_ONLY Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.
READ_WRITE [Default] Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode.
source

string

The URL of the disk resource that is stateful and should be attached to the VM instance.

Project

Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.
Fields
commonInstanceMetadata

object (Metadata)

Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.

commonInstanceMetadata.items.key

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.

commonInstanceMetadata.items.value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

defaultNetworkTier

enum

This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.

Enum type. Can be one of the following:
FIXED_STANDARD Public internet quality with fixed bandwidth.
PREMIUM High quality, Google-grade network tier, support for all networking products.
STANDARD Public internet quality, only limited support for other networking products.
STANDARD_OVERRIDES_FIXED_STANDARD (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
defaultServiceAccount

string

[Output Only] Default service account used by VMs running in this project.

description

string

An optional textual description of the resource.

enabledFeatures[]

string

Restricted features enabled for use on this project.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.

kind

string

[Output Only] Type of the resource. Always compute#project for projects.

name

string

The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.

quotas[]

object (Quota)

[Output Only] Quotas assigned to this project.

selfLink

string

[Output Only] Server-defined URL for the resource.

usageExportLocation

object (UsageExportLocation)

The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.

vmDnsSetting

enum

[Output Only] Default internal DNS setting used by VMs running in this project.

Enum type. Can be one of the following:
GLOBAL_DEFAULT (No description provided)
UNSPECIFIED_VM_DNS_SETTING (No description provided)
ZONAL_DEFAULT (No description provided)
ZONAL_ONLY (No description provided)
xpnProjectStatus

enum

[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.

Enum type. Can be one of the following:
HOST (No description provided)
UNSPECIFIED_XPN_PROJECT_STATUS (No description provided)

ProjectsDisableXpnResourceRequest

(No description provided)
Fields
xpnResource

object (XpnResourceId)

Service resource (a.k.a service project) ID.

ProjectsEnableXpnResourceRequest

(No description provided)
Fields
xpnResource

object (XpnResourceId)

Service resource (a.k.a service project) ID.

ProjectsGetXpnResources

(No description provided)
Fields
kind

string

[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects)

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

resources[]

object (XpnResourceId)

Service resources (a.k.a service projects) attached to this project as their shared VPC host.

ProjectsListXpnHostsRequest

(No description provided)
Fields
organization

string

Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project.

ProjectsSetDefaultNetworkTierRequest

(No description provided)
Fields
networkTier

enum

Default network tier to be set.

Enum type. Can be one of the following:
FIXED_STANDARD Public internet quality with fixed bandwidth.
PREMIUM High quality, Google-grade network tier, support for all networking products.
STANDARD Public internet quality, only limited support for other networking products.
STANDARD_OVERRIDES_FIXED_STANDARD (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

PublicAdvertisedPrefix

A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

dnsVerificationIp

string

The address to be used for reverse DNS verification.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.

ipCidrRange

string

The address range, in CIDR format, represented by this public advertised prefix.

kind

string

[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

publicDelegatedPrefixs[]

object (PublicAdvertisedPrefixPublicDelegatedPrefix)

[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

selfLink

string

[Output Only] Server-defined URL for the resource.

sharedSecret

string

[Output Only] The shared secret to be used for reverse DNS verification.

status

enum

The status of the public advertised prefix. Possible values include: - INITIAL: RPKI validation is complete. - PTR_CONFIGURED: User has configured the PTR. - VALIDATED: Reverse DNS lookup is successful. - REVERSE_DNS_LOOKUP_FAILED: Reverse DNS lookup failed. - PREFIX_CONFIGURATION_IN_PROGRESS: The prefix is being configured. - PREFIX_CONFIGURATION_COMPLETE: The prefix is fully configured. - PREFIX_REMOVAL_IN_PROGRESS: The prefix is being removed.

Enum type. Can be one of the following:
INITIAL RPKI validation is complete.
PREFIX_CONFIGURATION_COMPLETE The prefix is fully configured.
PREFIX_CONFIGURATION_IN_PROGRESS The prefix is being configured.
PREFIX_REMOVAL_IN_PROGRESS The prefix is being removed.
PTR_CONFIGURED User has configured the PTR.
REVERSE_DNS_LOOKUP_FAILED Reverse DNS lookup failed.
VALIDATED Reverse DNS lookup is successful.

PublicAdvertisedPrefixList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (PublicAdvertisedPrefix)

A list of PublicAdvertisedPrefix resources.

kind

string

[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

PublicAdvertisedPrefixPublicDelegatedPrefix

Represents a CIDR range which can be used to assign addresses.
Fields
ipRange

string

The IP address range of the public delegated prefix

name

string

The name of the public delegated prefix

project

string

The project number of the public delegated prefix

region

string

The region of the public delegated prefix if it is regional. If absent, the prefix is global.

status

string

The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.

PublicDelegatedPrefix

A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.

ipCidrRange

string

The IP address range, in CIDR format, represented by this public delegated prefix.

isLiveMigration

boolean

If true, the prefix will be live migrated.

kind

string

[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

parentPrefix

string

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

publicDelegatedSubPrefixs[]

object (PublicDelegatedPrefixPublicDelegatedSubPrefix)

The list of sub public delegated prefixes that exist for this public delegated prefix.

region

string

[Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

status

enum

[Output Only] The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned.

Enum type. Can be one of the following:
ANNOUNCED The public delegated prefix is active.
DELETING The public delegated prefix is being deprovsioned.
INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet.
READY_TO_ANNOUNCE The public delegated prefix is currently withdrawn but ready to be announced.

PublicDelegatedPrefixAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (PublicDelegatedPrefixesScopedList))

A list of PublicDelegatedPrefixesScopedList resources.

kind

string

[Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList for aggregated lists of public delegated prefixes.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

PublicDelegatedPrefixList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (PublicDelegatedPrefix)

A list of PublicDelegatedPrefix resources.

kind

string

[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

PublicDelegatedPrefixPublicDelegatedSubPrefix

Represents a sub PublicDelegatedPrefix.
Fields
delegateeProject

string

Name of the project scoping this PublicDelegatedSubPrefix.

description

string

An optional description of this resource. Provide this property when you create the resource.

ipCidrRange

string

The IP address range, in CIDR format, represented by this sub public delegated prefix.

isAddress

boolean

Whether the sub prefix is delegated to create Address resources in the delegatee project.

name

string

The name of the sub public delegated prefix.

region

string

[Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.

status

enum

[Output Only] The status of the sub public delegated prefix.

Enum type. Can be one of the following:
ACTIVE (No description provided)
INACTIVE (No description provided)

PublicDelegatedPrefixesScopedList

(No description provided)
Fields
publicDelegatedPrefixes[]

object (PublicDelegatedPrefix)

[Output Only] A list of PublicDelegatedPrefixes contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of public delegated prefixes when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

Quota

A quotas entry.
Fields
limit

number (double format)

[Output Only] Quota limit for this metric.

metric

enum

[Output Only] Name of the quota metric.

Enum type. Can be one of the following:
A2_CPUS (No description provided)
AFFINITY_GROUPS (No description provided)
AUTOSCALERS (No description provided)
BACKEND_BUCKETS (No description provided)
BACKEND_SERVICES (No description provided)
C2D_CPUS (No description provided)
C2_CPUS (No description provided)
C3_CPUS (No description provided)
COMMITMENTS (No description provided)
COMMITTED_A2_CPUS (No description provided)
COMMITTED_C2D_CPUS (No description provided)
COMMITTED_C2_CPUS (No description provided)
COMMITTED_C3_CPUS (No description provided)
COMMITTED_CPUS (No description provided)
COMMITTED_E2_CPUS (No description provided)
COMMITTED_LICENSES (No description provided)
COMMITTED_LOCAL_SSD_TOTAL_GB (No description provided)
COMMITTED_M3_CPUS (No description provided)
COMMITTED_MEMORY_OPTIMIZED_CPUS (No description provided)
COMMITTED_N2A_CPUS (No description provided)
COMMITTED_N2D_CPUS (No description provided)
COMMITTED_N2_CPUS (No description provided)
COMMITTED_NVIDIA_A100_80GB_GPUS (No description provided)
COMMITTED_NVIDIA_A100_GPUS (No description provided)
COMMITTED_NVIDIA_K80_GPUS (No description provided)
COMMITTED_NVIDIA_L4_GPUS (No description provided)
COMMITTED_NVIDIA_P100_GPUS (No description provided)
COMMITTED_NVIDIA_P4_GPUS (No description provided)
COMMITTED_NVIDIA_T4_GPUS (No description provided)
COMMITTED_NVIDIA_V100_GPUS (No description provided)
COMMITTED_T2A_CPUS (No description provided)
COMMITTED_T2D_CPUS (No description provided)
CPUS Guest CPUs
CPUS_ALL_REGIONS (No description provided)
DISKS_TOTAL_GB (No description provided)
E2_CPUS (No description provided)
EXTERNAL_MANAGED_FORWARDING_RULES (No description provided)
EXTERNAL_NETWORK_LB_FORWARDING_RULES (No description provided)
EXTERNAL_PROTOCOL_FORWARDING_RULES (No description provided)
EXTERNAL_VPN_GATEWAYS (No description provided)
FIREWALLS (No description provided)
FORWARDING_RULES (No description provided)
GLOBAL_EXTERNAL_MANAGED_BACKEND_SERVICES (No description provided)
GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES (No description provided)
GLOBAL_EXTERNAL_PROXY_LB_BACKEND_SERVICES (No description provided)
GLOBAL_INTERNAL_ADDRESSES (No description provided)
GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES (No description provided)
GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES (No description provided)
GPUS_ALL_REGIONS (No description provided)
HEALTH_CHECKS (No description provided)
IMAGES (No description provided)
INSTANCES (No description provided)
INSTANCE_GROUPS (No description provided)
INSTANCE_GROUP_MANAGERS (No description provided)
INSTANCE_TEMPLATES (No description provided)
INTERCONNECTS (No description provided)
INTERCONNECT_ATTACHMENTS_PER_REGION (No description provided)
INTERCONNECT_ATTACHMENTS_TOTAL_MBPS (No description provided)
INTERCONNECT_TOTAL_GBPS (No description provided)
INTERNAL_ADDRESSES (No description provided)
INTERNAL_TRAFFIC_DIRECTOR_FORWARDING_RULES (No description provided)
IN_PLACE_SNAPSHOTS (No description provided)
IN_USE_ADDRESSES (No description provided)
IN_USE_BACKUP_SCHEDULES (No description provided)
IN_USE_SNAPSHOT_SCHEDULES (No description provided)
LOCAL_SSD_TOTAL_GB (No description provided)
M1_CPUS (No description provided)
M2_CPUS (No description provided)
M3_CPUS (No description provided)
MACHINE_IMAGES (No description provided)
N2A_CPUS (No description provided)
N2D_CPUS (No description provided)
N2_CPUS (No description provided)
NETWORKS (No description provided)
NETWORK_ATTACHMENTS (No description provided)
NETWORK_ENDPOINT_GROUPS (No description provided)
NETWORK_FIREWALL_POLICIES (No description provided)
NET_LB_SECURITY_POLICIES_PER_REGION (No description provided)
NET_LB_SECURITY_POLICY_RULES_PER_REGION (No description provided)
NET_LB_SECURITY_POLICY_RULE_ATTRIBUTES_PER_REGION (No description provided)
NODE_GROUPS (No description provided)
NODE_TEMPLATES (No description provided)
NVIDIA_A100_80GB_GPUS (No description provided)
NVIDIA_A100_GPUS (No description provided)
NVIDIA_K80_GPUS (No description provided)
NVIDIA_L4_GPUS (No description provided)
NVIDIA_P100_GPUS (No description provided)
NVIDIA_P100_VWS_GPUS (No description provided)
NVIDIA_P4_GPUS (No description provided)
NVIDIA_P4_VWS_GPUS (No description provided)
NVIDIA_T4_GPUS (No description provided)
NVIDIA_T4_VWS_GPUS (No description provided)
NVIDIA_V100_GPUS (No description provided)
PACKET_MIRRORINGS (No description provided)
PD_EXTREME_TOTAL_PROVISIONED_IOPS (No description provided)
PREEMPTIBLE_CPUS (No description provided)
PREEMPTIBLE_LOCAL_SSD_GB (No description provided)
PREEMPTIBLE_NVIDIA_A100_80GB_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_A100_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_K80_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_L4_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_P100_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_P100_VWS_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_P4_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_P4_VWS_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_T4_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_T4_VWS_GPUS (No description provided)
PREEMPTIBLE_NVIDIA_V100_GPUS (No description provided)
PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK (No description provided)
PSC_INTERNAL_LB_FORWARDING_RULES (No description provided)
PUBLIC_ADVERTISED_PREFIXES (No description provided)
PUBLIC_DELEGATED_PREFIXES (No description provided)
REGIONAL_AUTOSCALERS (No description provided)
REGIONAL_EXTERNAL_MANAGED_BACKEND_SERVICES (No description provided)
REGIONAL_EXTERNAL_NETWORK_LB_BACKEND_SERVICES (No description provided)
REGIONAL_INSTANCE_GROUP_MANAGERS (No description provided)
REGIONAL_INTERNAL_LB_BACKEND_SERVICES (No description provided)
REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES (No description provided)
RESERVATIONS (No description provided)
RESOURCE_POLICIES (No description provided)
ROUTERS (No description provided)
ROUTES (No description provided)
SECURITY_POLICIES (No description provided)
SECURITY_POLICIES_PER_REGION (No description provided)
SECURITY_POLICY_ADVANCED_RULES_PER_REGION (No description provided)
SECURITY_POLICY_CEVAL_RULES (No description provided)
SECURITY_POLICY_RULES (No description provided)
SECURITY_POLICY_RULES_PER_REGION (No description provided)
SERVICE_ATTACHMENTS (No description provided)
SNAPSHOTS The total number of snapshots allowed for a single project.
SSD_TOTAL_GB (No description provided)
SSL_CERTIFICATES (No description provided)
STATIC_ADDRESSES (No description provided)
STATIC_BYOIP_ADDRESSES (No description provided)
STATIC_EXTERNAL_IPV6_ADDRESS_RANGES (No description provided)
SUBNETWORKS (No description provided)
T2A_CPUS (No description provided)
T2D_CPUS (No description provided)
TARGET_HTTPS_PROXIES (No description provided)
TARGET_HTTP_PROXIES (No description provided)
TARGET_INSTANCES (No description provided)
TARGET_POOLS (No description provided)
TARGET_SSL_PROXIES (No description provided)
TARGET_TCP_PROXIES (No description provided)
TARGET_VPN_GATEWAYS (No description provided)
URL_MAPS (No description provided)
VPN_GATEWAYS (No description provided)
VPN_TUNNELS (No description provided)
XPN_SERVICE_PROJECTS (No description provided)
owner

string

[Output Only] Owning resource. This is the resource on which this quota is applied.

usage

number (double format)

[Output Only] Current usage of this metric.

QuotaExceededInfo

Additional details for quota exceeded error for resource quota.
Fields
dimensions

map (key: string, value: string)

The map holding related quota dimensions.

futureLimit

number (double format)

Future quota limit being rolled out. The limit's unit depends on the quota type or metric.

limit

number (double format)

Current effective quota limit. The limit's unit depends on the quota type or metric.

limitName

string

The name of the quota limit.

metricName

string

The Compute Engine quota metric name.

rolloutStatus

enum

Rollout status of the future quota limit.

Enum type. Can be one of the following:
IN_PROGRESS IN_PROGRESS - A rollout is in process which will change the limit value to future limit.
ROLLOUT_STATUS_UNSPECIFIED ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The default value.

Reference

Represents a reference to a resource.
Fields
kind

string

[Output Only] Type of the resource. Always compute#reference for references.

referenceType

string

A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF

referrer

string

URL of the resource which refers to the target.

target

string

URL of the resource to which this reference points.

Region

Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated

object (DeprecationStatus)

[Output Only] The deprecation status associated with this region.

description

string

[Output Only] Textual description of the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#region for regions.

name

string

[Output Only] Name of the resource.

quotas[]

object (Quota)

[Output Only] Quotas assigned to this region.

selfLink

string

[Output Only] Server-defined URL for the resource.

status

enum

[Output Only] Status of the region, either UP or DOWN.

Enum type. Can be one of the following:
DOWN (No description provided)
UP (No description provided)
supportsPzs

boolean

[Output Only] Reserved for future use.

zones[]

string

[Output Only] A list of zones available in this region, in the form of resource URLs.

RegionAddressesMoveRequest

(No description provided)
Fields
description

string

An optional destination address description if intended to be different from the source.

destinationAddress

string

The URL of the destination address to move to. This can be a full or partial URL. For example, the following are all valid URLs to a address: - https://www.googleapis.com/compute/v1/projects/project/regions/region /addresses/address - projects/project/regions/region/addresses/address Note that destination project must be different from the source project. So /regions/region/addresses/address is not valid partial url.

RegionAutoscalerList

Contains a list of autoscalers.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Autoscaler)

A list of Autoscaler resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RegionDiskTypeList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (DiskType)

A list of DiskType resources.

kind

string

[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RegionDisksAddResourcePoliciesRequest

(No description provided)
Fields
resourcePolicies[]

string

Resource policies to be added to this disk.

RegionDisksRemoveResourcePoliciesRequest

(No description provided)
Fields
resourcePolicies[]

string

Resource policies to be removed from this disk.

RegionDisksResizeRequest

(No description provided)
Fields
sizeGb

string (int64 format)

The new size of the regional persistent disk, which is specified in GB.

RegionDisksStartAsyncReplicationRequest

(No description provided)
Fields
asyncSecondaryDisk

string

The secondary disk to start asynchronous replication to. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

RegionInstanceGroupList

Contains a list of InstanceGroup resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InstanceGroup)

A list of InstanceGroup resources.

kind

string

The resource type.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RegionInstanceGroupManagerDeleteInstanceConfigReq

RegionInstanceGroupManagers.deletePerInstanceConfigs
Fields
names[]

string

The list of instance names for which we want to delete per-instance configs on this managed instance group.

RegionInstanceGroupManagerList

Contains a list of managed instance groups.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InstanceGroupManager)

A list of InstanceGroupManager resources.

kind

string

[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RegionInstanceGroupManagerPatchInstanceConfigReq

RegionInstanceGroupManagers.patchPerInstanceConfigs
Fields
perInstanceConfigs[]

object (PerInstanceConfig)

The list of per-instance configurations to insert or patch on this managed instance group.

RegionInstanceGroupManagerUpdateInstanceConfigReq

RegionInstanceGroupManagers.updatePerInstanceConfigs
Fields
perInstanceConfigs[]

object (PerInstanceConfig)

The list of per-instance configurations to insert or patch on this managed instance group.

RegionInstanceGroupManagersAbandonInstancesRequest

(No description provided)
Fields
instances[]

string

The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

RegionInstanceGroupManagersApplyUpdatesRequest

RegionInstanceGroupManagers.applyUpdatesToInstances
Fields
allInstances

boolean

Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.

instances[]

string

The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

minimalAction

enum

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.

Enum type. Can be one of the following:
NONE Do not perform any action.
REFRESH Do not stop the instance.
REPLACE (Default.) Replace the instance according to the replacement method option.
RESTART Stop the instance and start it again.
mostDisruptiveAllowedAction

enum

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.

Enum type. Can be one of the following:
NONE Do not perform any action.
REFRESH Do not stop the instance.
REPLACE (Default.) Replace the instance according to the replacement method option.
RESTART Stop the instance and start it again.

RegionInstanceGroupManagersCreateInstancesRequest

RegionInstanceGroupManagers.createInstances
Fields
instances[]

object (PerInstanceConfig)

[Required] List of specifications of per-instance configs.

RegionInstanceGroupManagersDeleteInstancesRequest

(No description provided)
Fields
instances[]

string

The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

skipInstancesOnValidationError

boolean

Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to false and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.

RegionInstanceGroupManagersListErrorsResponse

(No description provided)
Fields
items[]

object (InstanceManagedByIgmError)

[Output Only] The list of errors of the managed instance group.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

RegionInstanceGroupManagersListInstanceConfigsResp

(No description provided)
Fields
items[]

object (PerInstanceConfig)

[Output Only] The list of PerInstanceConfig.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RegionInstanceGroupManagersListInstancesResponse

(No description provided)
Fields
managedInstances[]

object (ManagedInstance)

A list of managed instances.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

RegionInstanceGroupManagersRecreateRequest

(No description provided)
Fields
instances[]

string

The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

RegionInstanceGroupManagersSetTargetPoolsRequest

(No description provided)
Fields
fingerprint

string (bytes format)

Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.

targetPools[]

string

The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

RegionInstanceGroupManagersSetTemplateRequest

(No description provided)
Fields
instanceTemplate

string

URL of the InstanceTemplate resource from which all new instances will be created.

RegionInstanceGroupsListInstances

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (InstanceWithNamedPorts)

A list of InstanceWithNamedPorts resources.

kind

string

The resource type.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RegionInstanceGroupsListInstancesRequest

(No description provided)
Fields
instanceState

enum

Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.

Enum type. Can be one of the following:
ALL Matches any status of the instances, running, non-running and others.
RUNNING Instance is in RUNNING state if it is running.
portName

string

Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.

RegionInstanceGroupsSetNamedPortsRequest

(No description provided)
Fields
fingerprint

string (bytes format)

The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.

namedPorts[]

object (NamedPort)

The list of named ports to set for this instance group.

RegionList

Contains a list of region resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Region)

A list of Region resources.

kind

string

[Output Only] Type of resource. Always compute#regionList for lists of regions.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse

(No description provided)
Fields
firewallPolicys[]

object (RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy)

Effective firewalls from firewall policy.

firewalls[]

object (Firewall)

Effective firewalls on the network.

RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy

(No description provided)
Fields
displayName

string

[Output Only] The display name of the firewall policy.

name

string

[Output Only] The name of the firewall policy.

rules[]

object (FirewallPolicyRule)

The rules that apply to the network.

type

enum

[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.

Enum type. Can be one of the following:
HIERARCHY (No description provided)
NETWORK (No description provided)
NETWORK_REGIONAL (No description provided)
UNSPECIFIED (No description provided)

RegionSetLabelsRequest

(No description provided)
Fields
labelFingerprint

string (bytes format)

The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.

labels

map (key: string, value: string)

The labels to set for this resource.

RegionSetPolicyRequest

(No description provided)
Fields
bindings[]

object (Binding)

Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

etag

string (bytes format)

Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

policy

object (Policy)

REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

RegionTargetHttpsProxiesSetSslCertificatesRequest

(No description provided)
Fields
sslCertificates[]

string

New set of SslCertificate resources to associate with this TargetHttpsProxy resource.

RegionUrlMapsValidateRequest

(No description provided)
Fields
resource

object (UrlMap)

Content of the UrlMap to be validated.

RequestMirrorPolicy

A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow.
Fields
backendService

string

The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.

Reservation

Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
Fields
commitment

string

[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#reservations for reservations.

name

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

resourcePolicies

map (key: string, value: string)

Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.

resourceStatus

object (AllocationResourceStatus)

[Output Only] Status information for Reservation resource.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

selfLink

string

[Output Only] Server-defined fully-qualified URL for this resource.

shareSettings

object (ShareSettings)

Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.

specificReservation

object (AllocationSpecificSKUReservation)

Reservation for instances with specific machine shapes.

specificReservationRequired

boolean

Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

status

enum

[Output Only] The status of the reservation.

Enum type. Can be one of the following:
CREATING Resources are being allocated for the reservation.
DELETING Reservation is currently being deleted.
INVALID (No description provided)
READY Reservation has allocated all its resources.
UPDATING Reservation is currently being resized.
zone

string

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

ReservationAffinity

Specifies the reservations that this instance can consume from.
Fields
consumeReservationType

enum

Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

Enum type. Can be one of the following:
ANY_RESERVATION Consume any allocation available.
NO_RESERVATION Do not consume from any allocated capacity.
SPECIFIC_RESERVATION Must consume from a specific reservation. Must specify key value fields for specifying the reservations.
UNSPECIFIED (No description provided)
key

string

Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

values[]

string

Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

ReservationAggregatedList

Contains a list of reservations.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (ReservationsScopedList))

A list of Allocation resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ReservationList

(No description provided)
Fields
id

string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items[]

object (Reservation)

[Output Only] A list of Allocation resources.

kind

string

[Output Only] Type of resource.Always compute#reservationsList for listsof reservations

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ReservationsResizeRequest

(No description provided)
Fields
specificSkuCount

string (int64 format)

Number of allocated resources can be resized with minimum = 1 and maximum = 1000.

ReservationsScopedList

(No description provided)
Fields
reservations[]

object (Reservation)

A list of reservations contained in this scope.

warning

object

Informational warning which replaces the list of reservations when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ResourceCommitment

Commitment for a particular resource (a Commitment is composed of one or more of these).
Fields
acceleratorType

string

Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.

amount

string (int64 format)

The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.

type

enum

Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.

Enum type. Can be one of the following:
ACCELERATOR (No description provided)
LOCAL_SSD (No description provided)
MEMORY (No description provided)
UNSPECIFIED (No description provided)
VCPU (No description provided)

ResourceGroupReference

(No description provided)
Fields
group

string

A URI referencing one of the instance groups or network endpoint groups listed in the backend service.

ResourcePoliciesScopedList

(No description provided)
Fields
resourcePolicies[]

object (ResourcePolicy)

A list of resourcePolicies contained in this scope.

warning

object

Informational warning which replaces the list of resourcePolicies when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ResourcePolicy

Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

(No description provided)

diskConsistencyGroupPolicy

object (ResourcePolicyDiskConsistencyGroupPolicy)

Resource policy for disk consistency groups.

groupPlacementPolicy

object (ResourcePolicyGroupPlacementPolicy)

Resource policy for instances for placement configuration.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

instanceSchedulePolicy

object (ResourcePolicyInstanceSchedulePolicy)

Resource policy for scheduling instance operations.

kind

string

[Output Only] Type of the resource. Always compute#resource_policies for resource policies.

name

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region

string

(No description provided)

resourceStatus

object (ResourcePolicyResourceStatus)

[Output Only] The system status of the resource policy.

selfLink

string

[Output Only] Server-defined fully-qualified URL for this resource.

snapshotSchedulePolicy

object (ResourcePolicySnapshotSchedulePolicy)

Resource policy for persistent disks for creating snapshots.

status

enum

[Output Only] The status of resource policy creation.

Enum type. Can be one of the following:
CREATING Resource policy is being created.
DELETING Resource policy is being deleted.
EXPIRED Resource policy is expired and will not run again.
INVALID (No description provided)
READY Resource policy is ready to be used.

ResourcePolicyAggregatedList

Contains a list of resourcePolicies.
Fields
etag

string

(No description provided)

id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (ResourcePoliciesScopedList))

A list of ResourcePolicy resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ResourcePolicyDailyCycle

Time window specified for daily operations.
Fields
daysInCycle

integer (int32 format)

Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle.

duration

string

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

startTime

string

Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

ResourcePolicyGroupPlacementPolicy

A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality
Fields
availabilityDomainCount

integer (int32 format)

The number of availability domains to spread instances across. If two instances are in different availability domain, they are not in the same low latency network.

collocation

enum

Specifies network collocation

Enum type. Can be one of the following:
COLLOCATED (No description provided)
UNSPECIFIED_COLLOCATION (No description provided)
vmCount

integer (int32 format)

Number of VMs in this placement group. Google does not recommend that you use this field unless you use a compact policy and you want your policy to work only if it contains this exact number of VMs.

ResourcePolicyHourlyCycle

Time window specified for hourly operations.
Fields
duration

string

[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

hoursInCycle

integer (int32 format)

Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.

startTime

string

Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

ResourcePolicyInstanceSchedulePolicy

An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance.
Fields
expirationTime

string

The expiration time of the schedule. The timestamp is an RFC3339 string.

startTime

string

The start time of the schedule. The timestamp is an RFC3339 string.

timeZone

string

Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: https://wikipedia.org/wiki/Tz_database.

vmStartSchedule

object (ResourcePolicyInstanceSchedulePolicySchedule)

Specifies the schedule for starting instances.

vmStopSchedule

object (ResourcePolicyInstanceSchedulePolicySchedule)

Specifies the schedule for stopping instances.

ResourcePolicyInstanceSchedulePolicySchedule

Schedule for an instance operation.
Fields
schedule

string

Specifies the frequency for the operation, using the unix-cron format.

ResourcePolicyList

(No description provided)
Fields
etag

string

(No description provided)

id

string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items[]

object (ResourcePolicy)

[Output Only] A list of ResourcePolicy resources.

kind

string

[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ResourcePolicyResourceStatus

Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this "status" field should mimic the structure of ResourcePolicy proto specification.
Fields
instanceSchedulePolicy

object (ResourcePolicyResourceStatusInstanceSchedulePolicyStatus)

[Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field.

ResourcePolicyResourceStatusInstanceSchedulePolicyStatus

(No description provided)
Fields
lastRunStartTime

string

[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.

nextRunStartTime

string

[Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.

ResourcePolicySnapshotSchedulePolicy

A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.
Fields
retentionPolicy

object (ResourcePolicySnapshotSchedulePolicyRetentionPolicy)

Retention policy applied to snapshots created by this resource policy.

schedule

object (ResourcePolicySnapshotSchedulePolicySchedule)

A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.

snapshotProperties

object (ResourcePolicySnapshotSchedulePolicySnapshotProperties)

Properties with which snapshots are created such as labels, encryption keys.

ResourcePolicySnapshotSchedulePolicyRetentionPolicy

Policy for retention of scheduled snapshots.
Fields
maxRetentionDays

integer (int32 format)

Maximum age of the snapshot that is allowed to be kept.

onSourceDiskDelete

enum

Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.

Enum type. Can be one of the following:
APPLY_RETENTION_POLICY (No description provided)
KEEP_AUTO_SNAPSHOTS (No description provided)
UNSPECIFIED_ON_SOURCE_DISK_DELETE (No description provided)

ResourcePolicySnapshotSchedulePolicySchedule

A schedule for disks where the schedueled operations are performed.
Fields
dailySchedule

object (ResourcePolicyDailyCycle)

(No description provided)

hourlySchedule

object (ResourcePolicyHourlyCycle)

(No description provided)

weeklySchedule

object (ResourcePolicyWeeklyCycle)

(No description provided)

ResourcePolicySnapshotSchedulePolicySnapshotProperties

Specified snapshot properties for scheduled snapshots created by this policy.
Fields
chainName

string

Chain name that the snapshot is created in.

guestFlush

boolean

Indication to perform a 'guest aware' snapshot.

labels

map (key: string, value: string)

Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.

storageLocations[]

string

Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).

ResourcePolicyWeeklyCycle

Time window specified for weekly operations.
Fields
dayOfWeeks[]

object (ResourcePolicyWeeklyCycleDayOfWeek)

Up to 7 intervals/windows, one for each day of the week.

ResourcePolicyWeeklyCycleDayOfWeek

(No description provided)
Fields
day

enum

Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

Enum type. Can be one of the following:
FRIDAY (No description provided)
INVALID (No description provided)
MONDAY (No description provided)
SATURDAY (No description provided)
SUNDAY (No description provided)
THURSDAY (No description provided)
TUESDAY (No description provided)
WEDNESDAY (No description provided)
duration

string

[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

startTime

string

Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

ResourceStatus

Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.
Fields
physicalHost

string

[Output Only] An opaque ID of the host on which the VM is running.

Route

Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.
Fields
asPaths[]

object (RouteAsPath)

[Output Only] AS path.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this field when you create the resource.

destRange

string

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of this resource. Always compute#routes for Route resources.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

network

string

Fully-qualified URL of the network that this route applies to.

nextHopGateway

string

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

nextHopHub

string

[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

nextHopIlb

string

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

nextHopInstance

string

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

nextHopIp

string

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

nextHopNetwork

string

The URL of the local network if it should handle matching packets.

nextHopPeering

string

[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

nextHopVpnTunnel

string

The URL to a VpnTunnel that should handle matching packets.

priority

integer (uint32 format)

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.

routeStatus

enum

[Output only] The status of the route.

Enum type. Can be one of the following:
ACTIVE This route is processed and active.
DROPPED The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
INACTIVE This route is processed but inactive due to failure from the backend. The backend may have rejected the route
PENDING This route is being processed internally. The status will change once processed.
routeType

enum

[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route

Enum type. Can be one of the following:
BGP (No description provided)
STATIC (No description provided)
SUBNET (No description provided)
TRANSIT (No description provided)
selfLink

string

[Output Only] Server-defined fully-qualified URL for this resource.

tags[]

string

A list of instance tags to which this route applies.

warnings[]

object

[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

warnings.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warnings.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warnings.data.key

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).

warnings.data.value

string

[Output Only] A warning data value corresponding to the key.

warnings.message

string

[Output Only] A human-readable description of the warning code.

RouteAsPath

(No description provided)
Fields
asLists[]

integer (uint32 format)

[Output Only] The AS numbers of the AS Path.

pathSegmentType

enum

[Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

Enum type. Can be one of the following:
AS_CONFED_SEQUENCE (No description provided)
AS_CONFED_SET (No description provided)
AS_SEQUENCE (No description provided)
AS_SET (No description provided)

RouteList

Contains a list of Route resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Route)

A list of Route resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

Router

Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.
Fields
bgp

object (RouterBgp)

BGP information specific to this router.

bgpPeers[]

object (RouterBgpPeer)

BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

encryptedInterconnectRouter

boolean

Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

interfaces[]

object (RouterInterface)

Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

kind

string

[Output Only] Type of resource. Always compute#router for routers.

md5AuthenticationKeys[]

object (RouterMd5AuthenticationKey)

Keys used for MD5 authentication.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

nats[]

object (RouterNat)

A list of NAT services created in this router.

network

string

URI of the network to which this router belongs.

region

string

[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

RouterAdvertisedIpRange

Description-tagged IP ranges for the router to advertise.
Fields
description

string

User-specified description for the IP range.

range

string

The IP range to advertise. The value must be a CIDR-formatted string.

RouterAggregatedList

Contains a list of routers.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (RoutersScopedList))

A list of Router resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RouterBgp

(No description provided)
Fields
advertiseMode

enum

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

Enum type. Can be one of the following:
CUSTOM (No description provided)
DEFAULT (No description provided)
advertisedGroups[]

string

User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

advertisedIpRanges[]

object (RouterAdvertisedIpRange)

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

asn

integer (uint32 format)

Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

keepaliveInterval

integer (uint32 format)

The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

RouterBgpPeer

(No description provided)
Fields
advertiseMode

enum

User-specified flag to indicate which mode to use for advertisement.

Enum type. Can be one of the following:
CUSTOM (No description provided)
DEFAULT (No description provided)
advertisedGroups[]

string

User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

advertisedIpRanges[]

object (RouterAdvertisedIpRange)

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

advertisedRoutePriority

integer (uint32 format)

The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

bfd

object (RouterBgpPeerBfd)

BFD configuration for the BGP peering.

customLearnedIpRanges[]

object (RouterBgpPeerCustomLearnedIpRange)

A list of user-defined custom learned route IP address ranges for a BGP session.

customLearnedRoutePriority

integer (int32 format)

The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

enable

enum

The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Enum type. Can be one of the following:
FALSE (No description provided)
TRUE (No description provided)
enableIpv6

boolean

Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.

interfaceName

string

Name of the interface the BGP peer is associated with.

ipAddress

string

IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

ipv6NexthopAddress

string

IPv6 address of the interface inside Google Cloud Platform.

managementType

enum

[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Enum type. Can be one of the following:
MANAGED_BY_ATTACHMENT The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
MANAGED_BY_USER Default value, the BGP peer is manually created and managed by user.
md5AuthenticationKeyName

string

Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.

name

string

Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

peerAsn

integer (uint32 format)

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

peerIpAddress

string

IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

peerIpv6NexthopAddress

string

IPv6 address of the BGP interface outside Google Cloud Platform.

routerApplianceInstance

string

URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

RouterBgpPeerBfd

(No description provided)
Fields
minReceiveInterval

integer (uint32 format)

The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.

minTransmitInterval

integer (uint32 format)

The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.

multiplier

integer (uint32 format)

The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.

sessionInitializationMode

enum

The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.

Enum type. Can be one of the following:
ACTIVE (No description provided)
DISABLED (No description provided)
PASSIVE (No description provided)

RouterBgpPeerCustomLearnedIpRange

(No description provided)
Fields
range

string

The custom learned route IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

RouterInterface

(No description provided)
Fields
ipRange

string

IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

linkedInterconnectAttachment

string

URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

linkedVpnTunnel

string

URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

managementType

enum

[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Enum type. Can be one of the following:
MANAGED_BY_ATTACHMENT The interface is automatically created for PARTNER type InterconnectAttachment, Google will automatically create/update/delete this interface when the PARTNER InterconnectAttachment is created/provisioned/deleted. This type of interface cannot be manually managed by user.
MANAGED_BY_USER Default value, the interface is manually created and managed by user.
name

string

Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

privateIpAddress

string

The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

redundantInterface

string

Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

subnetwork

string

The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

RouterList

Contains a list of Router resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Router)

A list of Router resources.

kind

string

[Output Only] Type of resource. Always compute#router for routers.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

RouterMd5AuthenticationKey

(No description provided)
Fields
key

string

[Input only] Value of the key. For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.

name

string

Name used to identify the key. Must be unique within a router. Must be referenced by at least one bgpPeer. Must comply with RFC1035.

RouterNat

Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.
Fields
autoNetworkTier

enum

The network tier to use when automatically reserving IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, PREMIUM tier will be used.

Enum type. Can be one of the following:
FIXED_STANDARD Public internet quality with fixed bandwidth.
PREMIUM High quality, Google-grade network tier, support for all networking products.
STANDARD Public internet quality, only limited support for other networking products.
STANDARD_OVERRIDES_FIXED_STANDARD (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
drainNatIps[]

string

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

enableDynamicPortAllocation

boolean

Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.

enableEndpointIndependentMapping

boolean

(No description provided)

endpointTypes[]

string

List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM

icmpIdleTimeoutSec

integer (int32 format)

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

logConfig

object (RouterNatLogConfig)

Configure logging on this NAT.

maxPortsPerVm

integer (int32 format)

Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.

minPortsPerVm

integer (int32 format)

Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

name

string

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

natIpAllocateOption

enum

Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Enum type. Can be one of the following:
AUTO_ONLY Nat IPs are allocated by GCP; customers can not specify any Nat IPs.
MANUAL_ONLY Only use Nat IPs provided by customers. When specified Nat IPs are not enough then the Nat service fails for new VMs.
natIps[]

string

A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

rules[]

object (RouterNatRule)

A list of rules associated with this NAT.

sourceSubnetworkIpRangesToNat

enum

Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region.

Enum type. Can be one of the following:
ALL_SUBNETWORKS_ALL_IP_RANGES All the IP ranges in every Subnetwork are allowed to Nat.
ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES All the primary IP ranges in every Subnetwork are allowed to Nat.
LIST_OF_SUBNETWORKS A list of Subnetworks are allowed to Nat (specified in the field subnetwork below)
subnetworks[]

object (RouterNatSubnetworkToNat)

A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

tcpEstablishedIdleTimeoutSec

integer (int32 format)

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

tcpTimeWaitTimeoutSec

integer (int32 format)

Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

tcpTransitoryIdleTimeoutSec

integer (int32 format)

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

udpIdleTimeoutSec

integer (int32 format)

Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

RouterNatLogConfig

Configuration of logging on a NAT.
Fields
enable

boolean

Indicates whether or not to export logs. This is false by default.

filter

enum

Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Enum type. Can be one of the following:
ALL Export logs for all (successful and unsuccessful) connections.
ERRORS_ONLY Export logs for connection failures only.
TRANSLATIONS_ONLY Export logs for successful connections only.

RouterNatRule

(No description provided)
Fields
action

object (RouterNatRuleAction)

The action to be enforced for traffic that matches this rule.

description

string

An optional description of this rule.

match

string

CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding action is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'"

ruleNumber

integer (uint32 format)

An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

RouterNatRuleAction

(No description provided)
Fields
sourceNatActiveIps[]

string

A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT.

sourceNatDrainIps[]

string

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT.

RouterNatSubnetworkToNat

Defines the IP ranges that want to use NAT for a subnetwork.
Fields
name

string

URL for the subnetwork resource that will use NAT.

secondaryIpRangeNames[]

string

A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

sourceIpRangesToNat[]

string

Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

RouterStatus

(No description provided)
Fields
bestRoutes[]

object (Route)

Best routes for this router's network.

bestRoutesForRouter[]

object (Route)

Best routes learned by this router.

bgpPeerStatus[]

object (RouterStatusBgpPeerStatus)

(No description provided)

natStatus[]

object (RouterStatusNatStatus)

(No description provided)

network

string

URI of the network to which this router belongs.

RouterStatusBgpPeerStatus

(No description provided)
Fields
advertisedRoutes[]

object (Route)

Routes that were advertised to the remote BGP peer

bfdStatus

object (BfdStatus)

(No description provided)

enableIpv6

boolean

Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.

ipAddress

string

IP address of the local BGP interface.

ipv6NexthopAddress

string

IPv6 address of the local BGP interface.

linkedVpnTunnel

string

URL of the VPN tunnel that this BGP peer controls.

md5AuthEnabled

boolean

Informs whether MD5 authentication is enabled on this BGP peer.

name

string

Name of this BGP peer. Unique within the Routers resource.

numLearnedRoutes

integer (uint32 format)

Number of routes learned from the remote BGP Peer.

peerIpAddress

string

IP address of the remote BGP interface.

peerIpv6NexthopAddress

string

IPv6 address of the remote BGP interface.

routerApplianceInstance

string

[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session.

state

string

The state of the BGP session. For a list of possible values for this field, see BGP session states.

status

enum

Status of the BGP peer: {UP, DOWN}

Enum type. Can be one of the following:
DOWN (No description provided)
UNKNOWN (No description provided)
UP (No description provided)
statusReason

enum

Indicates why particular status was returned.

Enum type. Can be one of the following:
MD5_AUTH_INTERNAL_PROBLEM Indicates internal problems with configuration of MD5 authentication. This particular reason can only be returned when md5AuthEnabled is true and status is DOWN.
STATUS_REASON_UNSPECIFIED (No description provided)
uptime

string

Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds

uptimeSeconds

string

Time this session has been up, in seconds. Format: 145

RouterStatusNatStatus

Status of a NAT contained in this router.
Fields
autoAllocatedNatIps[]

string

A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

drainAutoAllocatedNatIps[]

string

A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

drainUserAllocatedNatIps[]

string

A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

minExtraNatIpsNeeded

integer (int32 format)

The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is not used.

name

string

Unique name of this NAT.

numVmEndpointsWithNatMappings

integer (int32 format)

Number of VM endpoints (i.e., Nics) that can use NAT.

ruleStatus[]

object (RouterStatusNatStatusNatRuleStatus)

Status of rules in this NAT.

userAllocatedNatIpResources[]

string

A list of fully qualified URLs of reserved IP address resources.

userAllocatedNatIps[]

string

A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

RouterStatusNatStatusNatRuleStatus

Status of a NAT Rule contained in this NAT.
Fields
activeNatIps[]

string

A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].

drainNatIps[]

string

A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

minExtraIpsNeeded

integer (int32 format)

The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.

numVmEndpointsWithNatMappings

integer (int32 format)

Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.

ruleNumber

integer (int32 format)

Rule number of the rule.

RouterStatusResponse

(No description provided)
Fields
kind

string

Type of resource.

result

object (RouterStatus)

(No description provided)

RoutersPreviewResponse

(No description provided)
Fields
resource

object (Router)

Preview of given router.

RoutersScopedList

(No description provided)
Fields
routers[]

object (Router)

A list of routers contained in this scope.

warning

object

Informational warning which replaces the list of routers when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

Rule

This is deprecated and has no effect. Do not use.
Fields
action

enum

This is deprecated and has no effect. Do not use.

Enum type. Can be one of the following:
ALLOW This is deprecated and has no effect. Do not use.
ALLOW_WITH_LOG This is deprecated and has no effect. Do not use.
DENY This is deprecated and has no effect. Do not use.
DENY_WITH_LOG This is deprecated and has no effect. Do not use.
LOG This is deprecated and has no effect. Do not use.
NO_ACTION This is deprecated and has no effect. Do not use.
conditions[]

object (Condition)

This is deprecated and has no effect. Do not use.

description

string

This is deprecated and has no effect. Do not use.

ins[]

string

This is deprecated and has no effect. Do not use.

logConfigs[]

object (LogConfig)

This is deprecated and has no effect. Do not use.

notIns[]

string

This is deprecated and has no effect. Do not use.

permissions[]

string

This is deprecated and has no effect. Do not use.

SSLHealthCheck

(No description provided)
Fields
port

integer (int32 format)

The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.

portName

string

Not supported.

portSpecification

enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.

Enum type. Can be one of the following:
USE_FIXED_PORT The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
USE_NAMED_PORT Not supported.
USE_SERVING_PORT For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.
proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)
request

string

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake.

response

string

Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

SavedAttachedDisk

DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.
Fields
autoDelete

boolean

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

boot

boolean

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

deviceName

string

Specifies the name of the disk attached to the source instance.

diskEncryptionKey

object (CustomerEncryptionKey)

The encryption key for the disk.

diskSizeGb

string (int64 format)

The size of the disk in base-2 GB.

diskType

string

[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd

guestOsFeatures[]

object (GuestOsFeature)

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

index

integer (int32 format)

Specifies zero-based index of the disk that is attached to the source instance.

interface

enum

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.

Enum type. Can be one of the following:
NVME (No description provided)
SCSI (No description provided)
kind

string

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

licenses[]

string

[Output Only] Any valid publicly visible licenses.

mode

enum

The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.

Enum type. Can be one of the following:
READ_ONLY Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.
READ_WRITE [Default] Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.
source

string

Specifies a URL of the disk attached to the source instance.

storageBytes

string (int64 format)

[Output Only] A size of the storage used by the disk's snapshot by this machine image.

storageBytesStatus

enum

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

Enum type. Can be one of the following:
UPDATING (No description provided)
UP_TO_DATE (No description provided)
type

enum

Specifies the type of the attached disk, either SCRATCH or PERSISTENT.

Enum type. Can be one of the following:
PERSISTENT (No description provided)
SCRATCH (No description provided)

SavedDisk

An instance-attached disk resource.
Fields
architecture

enum

[Output Only] The architecture of the attached disk.

Enum type. Can be one of the following:
ARCHITECTURE_UNSPECIFIED Default value indicating Architecture is not set.
ARM64 Machines with architecture ARM64
X86_64 Machines with architecture X86_64
kind

string

[Output Only] Type of the resource. Always compute#savedDisk for attached disks.

sourceDisk

string

Specifies a URL of the disk attached to the source instance.

storageBytes

string (int64 format)

[Output Only] Size of the individual disk snapshot used by this machine image.

storageBytesStatus

enum

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

Enum type. Can be one of the following:
UPDATING (No description provided)
UP_TO_DATE (No description provided)

ScalingScheduleStatus

(No description provided)
Fields
lastStartTime

string

[Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format.

nextStartTime

string

[Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format.

state

enum

[Output Only] The current state of a scaling schedule.

Enum type. Can be one of the following:
ACTIVE The current autoscaling recommendation is influenced by this scaling schedule.
DISABLED This scaling schedule has been disabled by the user.
OBSOLETE This scaling schedule will never become active again.
READY The current autoscaling recommendation is not influenced by this scaling schedule.

Scheduling

Sets the scheduling options for an Instance.
Fields
automaticRestart

boolean

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

instanceTerminationAction

enum

Specifies the termination action for the instance.

Enum type. Can be one of the following:
DELETE Delete the VM.
INSTANCE_TERMINATION_ACTION_UNSPECIFIED Default value. This value is unused.
STOP Stop the VM without storing in-memory content. default action.
localSsdRecoveryTimeout

object (Duration)

Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.

locationHint

string

An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

minNodeCpus

integer (int32 format)

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

nodeAffinities[]

object (SchedulingNodeAffinity)

A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

onHostMaintenance

enum

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.

Enum type. Can be one of the following:
MIGRATE [Default] Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
TERMINATE Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
preemptible

boolean

Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states.

provisioningModel

enum

Specifies the provisioning model of the instance.

Enum type. Can be one of the following:
SPOT Heavily discounted, no guaranteed runtime.
STANDARD Standard provisioning with user controlled runtime, no discounts.

SchedulingNodeAffinity

Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
Fields
key

string

Corresponds to the label key of Node resource.

operator

enum

Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

Enum type. Can be one of the following:
IN Requires Compute Engine to seek for matched nodes.
NOT_IN Requires Compute Engine to avoid certain nodes.
OPERATOR_UNSPECIFIED (No description provided)
values[]

string

Corresponds to the label values of Node resource.

Screenshot

An instance's screenshot.
Fields
contents

string

[Output Only] The Base64-encoded screenshot data.

kind

string

[Output Only] Type of the resource. Always compute#screenshot for the screenshots.

SecurityPoliciesAggregatedList

(No description provided)
Fields
etag

string

(No description provided)

id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (SecurityPoliciesScopedList))

A list of SecurityPoliciesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SecurityPoliciesListPreconfiguredExpressionSetsResponse

(No description provided)
Fields
preconfiguredExpressionSets

object (SecurityPoliciesWafConfig)

(No description provided)

SecurityPoliciesScopedList

(No description provided)
Fields
securityPolicies[]

object (SecurityPolicy)

A list of SecurityPolicies contained in this scope.

warning

object

Informational warning which replaces the list of security policies when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SecurityPoliciesWafConfig

(No description provided)
Fields
wafRules

object (PreconfiguredWafSet)

(No description provided)

SecurityPolicy

Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.
Fields
adaptiveProtectionConfig

object (SecurityPolicyAdaptiveProtectionConfig)

(No description provided)

advancedOptionsConfig

object (SecurityPolicyAdvancedOptionsConfig)

(No description provided)

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

ddosProtectionConfig

object (SecurityPolicyDdosProtectionConfig)

(No description provided)

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Specifies a fingerprint for this resource, 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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

recaptchaOptionsConfig

object (SecurityPolicyRecaptchaOptionsConfig)

(No description provided)

region

string

[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.

rules[]

object (SecurityPolicyRule)

A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "" for srcIpRanges and for the networkMatch condition every field must be either match "" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.

selfLink

string

[Output Only] Server-defined URL for the resource.

type

enum

The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.

Enum type. Can be one of the following:
CLOUD_ARMOR (No description provided)
CLOUD_ARMOR_EDGE (No description provided)
CLOUD_ARMOR_NETWORK (No description provided)

SecurityPolicyAdaptiveProtectionConfig

Configuration options for Cloud Armor Adaptive Protection (CAAP).
Fields
layer7DdosDefenseConfig

object (SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig)

If set to true, enables Cloud Armor Machine Learning.

SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig

Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
Fields
enable

boolean

If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

ruleVisibility

enum

Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

Enum type. Can be one of the following:
PREMIUM (No description provided)
STANDARD (No description provided)
thresholdConfigs[]

object (SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig)

Configuration options for layer7 adaptive protection for various customizable thresholds.

SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig

(No description provided)
Fields
autoDeployConfidenceThreshold

number (float format)

(No description provided)

autoDeployExpirationSec

integer (int32 format)

(No description provided)

autoDeployImpactedBaselineThreshold

number (float format)

(No description provided)

autoDeployLoadThreshold

number (float format)

(No description provided)

name

string

The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.

SecurityPolicyAdvancedOptionsConfig

(No description provided)
Fields
jsonCustomConfig

object (SecurityPolicyAdvancedOptionsConfigJsonCustomConfig)

Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.

jsonParsing

enum

(No description provided)

Enum type. Can be one of the following:
DISABLED (No description provided)
STANDARD (No description provided)
logLevel

enum

(No description provided)

Enum type. Can be one of the following:
NORMAL (No description provided)
VERBOSE (No description provided)

SecurityPolicyAdvancedOptionsConfigJsonCustomConfig

(No description provided)
Fields
contentTypes[]

string

A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type "/" subtype *[";" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.

SecurityPolicyDdosProtectionConfig

(No description provided)
Fields
ddosProtection

enum

(No description provided)

Enum type. Can be one of the following:
ADVANCED (No description provided)
STANDARD (No description provided)

SecurityPolicyList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (SecurityPolicy)

A list of SecurityPolicy resources.

kind

string

[Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SecurityPolicyRecaptchaOptionsConfig

(No description provided)
Fields
redirectSiteKey

string

An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

SecurityPolicyReference

(No description provided)
Fields
securityPolicy

string

(No description provided)

SecurityPolicyRule

Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
Fields
action

string

The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.

description

string

An optional description of this resource. Provide this property when you create the resource.

headerAction

object (SecurityPolicyRuleHttpHeaderAction)

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

kind

string

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

match

object (SecurityPolicyRuleMatcher)

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

preconfiguredWafConfig

object (SecurityPolicyRulePreconfiguredWafConfig)

Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.

preview

boolean

If set to true, the specified action is not enforced.

priority

integer (int32 format)

An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.

rateLimitOptions

object (SecurityPolicyRuleRateLimitOptions)

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.

redirectOptions

object (SecurityPolicyRuleRedirectOptions)

Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

SecurityPolicyRuleHttpHeaderAction

(No description provided)
Fields
requestHeadersToAdds[]

object (SecurityPolicyRuleHttpHeaderActionHttpHeaderOption)

The list of request headers to add or overwrite if they're already present.

SecurityPolicyRuleHttpHeaderActionHttpHeaderOption

(No description provided)
Fields
headerName

string

The name of the header to set.

headerValue

string

The value to set the named header to.

SecurityPolicyRuleMatcher

Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.
Fields
config

object (SecurityPolicyRuleMatcherConfig)

The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.

expr

object (Expr)

User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing evaluateThreatIntelligence require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing evaluatePreconfiguredExpr('sourceiplist-*') require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.

versionedExpr

enum

Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.

Enum type. Can be one of the following:
SRC_IPS_V1 Matches the source IP address of a request to the IP ranges supplied in config.

SecurityPolicyRuleMatcherConfig

(No description provided)
Fields
srcIpRanges[]

string

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

SecurityPolicyRulePreconfiguredWafConfig

(No description provided)
Fields
exclusions[]

object (SecurityPolicyRulePreconfiguredWafConfigExclusion)

A list of exclusions to apply during preconfigured WAF evaluation.

SecurityPolicyRulePreconfiguredWafConfigExclusion

(No description provided)
Fields
requestCookiesToExclude[]

object (SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams)

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.

requestHeadersToExclude[]

object (SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams)

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.

requestQueryParamsToExclude[]

object (SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams)

A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.

requestUrisToExclude[]

object (SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams)

A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.

targetRuleIds[]

string

A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.

targetRuleSet

string

Target WAF rule set to apply the preconfigured WAF exclusion.

SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams

(No description provided)
Fields
op

enum

The match operator for the field.

Enum type. Can be one of the following:
CONTAINS The operator matches if the field value contains the specified value.
ENDS_WITH The operator matches if the field value ends with the specified value.
EQUALS The operator matches if the field value equals the specified value.
EQUALS_ANY The operator matches if the field value is any value.
STARTS_WITH The operator matches if the field value starts with the specified value.
val

string

The value of the field.

SecurityPolicyRuleRateLimitOptions

(No description provided)
Fields
banDurationSec

integer (int32 format)

Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

banThreshold

object (SecurityPolicyRuleRateLimitOptionsThreshold)

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

conformAction

string

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

enforceOnKey

enum

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates.

Enum type. Can be one of the following:
ALL (No description provided)
HTTP_COOKIE (No description provided)
HTTP_HEADER (No description provided)
HTTP_PATH (No description provided)
IP (No description provided)
REGION_CODE (No description provided)
SNI (No description provided)
XFF_IP (No description provided)
enforceOnKeyConfigs[]

object (SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig)

If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.

enforceOnKeyName

string

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

exceedAction

string

Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502, and redirect, where the redirect parameters come from exceedRedirectOptions below. The redirect action is only supported in Global Security Policies of type CLOUD_ARMOR.

exceedRedirectOptions

object (SecurityPolicyRuleRedirectOptions)

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

rateLimitThreshold

object (SecurityPolicyRuleRateLimitOptionsThreshold)

Threshold at which to begin ratelimiting.

SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

(No description provided)
Fields
enforceOnKeyName

string

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

enforceOnKeyType

enum

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates.

Enum type. Can be one of the following:
ALL (No description provided)
HTTP_COOKIE (No description provided)
HTTP_HEADER (No description provided)
HTTP_PATH (No description provided)
IP (No description provided)
REGION_CODE (No description provided)
SNI (No description provided)
XFF_IP (No description provided)

SecurityPolicyRuleRateLimitOptionsThreshold

(No description provided)
Fields
count

integer (int32 format)

Number of HTTP(S) requests for calculating the threshold.

intervalSec

integer (int32 format)

Interval over which the threshold is computed.

SecurityPolicyRuleRedirectOptions

(No description provided)
Fields
target

string

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

type

enum

Type of the redirect action.

Enum type. Can be one of the following:
EXTERNAL_302 (No description provided)
GOOGLE_RECAPTCHA (No description provided)

SecuritySettings

The authentication and authorization settings for a BackendService.
Fields
awsV4Authentication

object (AWSV4Signature)

The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.

clientTlsPolicy

string

Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.

subjectAltNames[]

string

Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).

SerialPortOutput

An instance serial console output.
Fields
contents

string

[Output Only] The contents of the console output.

kind

string

[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

next

string (int64 format)

[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the contents property. Use this value in the next request as the start parameter.

selfLink

string

[Output Only] Server-defined URL for this resource.

start

string (int64 format)

The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the start value that was specified in the request.

ServerBinding

(No description provided)
Fields
type

enum

(No description provided)

Enum type. Can be one of the following:
RESTART_NODE_ON_ANY_SERVER Node may associate with any physical server over its lifetime.
RESTART_NODE_ON_MINIMAL_SERVERS Node may associate with minimal physical servers over its lifetime.
SERVER_BINDING_TYPE_UNSPECIFIED (No description provided)

ServiceAccount

A service account.
Fields
email

string

Email address of the service account.

scopes[]

string

The list of scopes to be made available for this service account.

ServiceAttachment

Represents a ServiceAttachment resource. A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service.
Fields
connectedEndpoints[]

object (ServiceAttachmentConnectedEndpoint)

[Output Only] An array of connections for all the consumers connected to this service attachment.

connectionPreference

enum

The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.

Enum type. Can be one of the following:
ACCEPT_AUTOMATIC (No description provided)
ACCEPT_MANUAL (No description provided)
CONNECTION_PREFERENCE_UNSPECIFIED (No description provided)
consumerAcceptLists[]

object (ServiceAttachmentConsumerProjectLimit)

Projects that are allowed to connect to this service attachment.

consumerRejectLists[]

string

Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

domainNames[]

string

If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1.

enableProxyProtocol

boolean

If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.

kind

string

[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

natSubnets[]

string

An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

producerForwardingRule

string

The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

pscServiceAttachmentId

object (Uint128)

[Output Only] An 128-bit global unique ID of the PSC service attachment.

reconcileConnections

boolean

This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true.

region

string

[Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

targetService

string

The URL of a service serving the endpoint identified by this service attachment.

ServiceAttachmentAggregatedList

Contains a list of ServiceAttachmentsScopedList.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (ServiceAttachmentsScopedList))

A list of ServiceAttachmentsScopedList resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ServiceAttachmentConnectedEndpoint

[Output Only] A connection connected to this service attachment.
Fields
consumerNetwork

string

The url of the consumer network.

endpoint

string

The url of a connected endpoint.

pscConnectionId

string (uint64 format)

The PSC connection id of the connected endpoint.

status

enum

The status of a connected endpoint to this service attachment.

Enum type. Can be one of the following:
ACCEPTED The connection has been accepted by the producer.
CLOSED The connection has been closed by the producer.
NEEDS_ATTENTION The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
PENDING The connection is pending acceptance by the producer.
REJECTED The consumer is still connected but not using the connection.
STATUS_UNSPECIFIED (No description provided)

ServiceAttachmentConsumerProjectLimit

(No description provided)
Fields
connectionLimit

integer (uint32 format)

The value of the limit to set.

networkUrl

string

The network URL for the network to set the limit for.

projectIdOrNum

string

The project id or number for the project to set the limit for.

ServiceAttachmentList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (ServiceAttachment)

A list of ServiceAttachment resources.

kind

string

[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ServiceAttachmentsScopedList

(No description provided)
Fields
serviceAttachments[]

object (ServiceAttachment)

A list of ServiceAttachments contained in this scope.

warning

object

Informational warning which replaces the list of service attachments when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SetCommonInstanceMetadataOperationMetadata

(No description provided)
Fields
clientOperationId

string

[Output Only] The client operation id.

perLocationOperations

map (key: string, value: object (SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo))

[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a

SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo

(No description provided)
Fields
error

object (Status)

[Output Only] If state is ABANDONED or FAILED, this field is populated.

state

enum

[Output Only] Status of the action, which can be one of the following: PROPAGATING, PROPAGATED, ABANDONED, FAILED, or DONE.

Enum type. Can be one of the following:
ABANDONED Operation not tracked in this location e.g. zone is marked as DOWN.
DONE Operation has completed successfully.
FAILED Operation is in an error state.
PROPAGATED Operation is confirmed to be in the location.
PROPAGATING Operation is not yet confirmed to have been created in the location.
UNSPECIFIED (No description provided)

ShareSettings

The share setting for reservations and sole tenancy node groups.
Fields
projectMap

map (key: string, value: object (ShareSettingsProjectConfig))

A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.

shareType

enum

Type of sharing for this shared-reservation

Enum type. Can be one of the following:
LOCAL Default value.
ORGANIZATION Shared-reservation is open to entire Organization
SHARE_TYPE_UNSPECIFIED Default value. This value is unused.
SPECIFIC_PROJECTS Shared-reservation is open to specific projects

ShareSettingsProjectConfig

Config for each project in the share settings.
Fields
projectId

string

The project ID, should be same as the key of this project config in the parent map.

ShieldedInstanceConfig

A set of Shielded Instance options.
Fields
enableIntegrityMonitoring

boolean

Defines whether the instance has integrity monitoring enabled. Enabled by default.

enableSecureBoot

boolean

Defines whether the instance has Secure Boot enabled. Disabled by default.

enableVtpm

boolean

Defines whether the instance has the vTPM enabled. Enabled by default.

ShieldedInstanceIdentity

A Shielded Instance Identity.
Fields
encryptionKey

object (ShieldedInstanceIdentityEntry)

An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

kind

string

[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

signingKey

object (ShieldedInstanceIdentityEntry)

An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

ShieldedInstanceIdentityEntry

A Shielded Instance Identity Entry.
Fields
ekCert

string

A PEM-encoded X.509 certificate. This field can be empty.

ekPub

string

A PEM-encoded public key.

ShieldedInstanceIntegrityPolicy

The policy describes the baseline against which Instance boot integrity is measured.
Fields
updateAutoLearnPolicy

boolean

Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

SignedUrlKey

Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs
Fields
keyName

string

Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

keyValue

string

128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.

Snapshot

Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
Fields
architecture

enum

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.

Enum type. Can be one of the following:
ARCHITECTURE_UNSPECIFIED Default value indicating Architecture is not set.
ARM64 Machines with architecture ARM64
X86_64 Machines with architecture X86_64
autoCreated

boolean

[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

chainName

string

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

creationSizeBytes

string (int64 format)

[Output Only] Size in bytes of the snapshot at creation time.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

diskSizeGb

string (int64 format)

[Output Only] Size of the source disk, specified in GB.

downloadBytes

string (int64 format)

[Output Only] Number of bytes downloaded to restore a snapshot to a disk.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.

labels

map (key: string, value: string)

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

licenseCodes[]

string (int64 format)

[Output Only] Integer license codes indicating which licenses are attached to this snapshot.

licenses[]

string

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

locationHint

string

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.

name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

selfLink

string

[Output Only] Server-defined URL for the resource.

snapshotEncryptionKey

object (CustomerEncryptionKey)

Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.

snapshotType

enum

Indicates the type of the snapshot.

Enum type. Can be one of the following:
ARCHIVE (No description provided)
STANDARD (No description provided)
sourceDisk

string

The source disk used to create this snapshot.

sourceDiskEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

sourceDiskId

string

[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

sourceSnapshotSchedulePolicy

string

[Output Only] URL of the resource policy which created this scheduled snapshot.

sourceSnapshotSchedulePolicyId

string

[Output Only] ID of the resource policy which created this scheduled snapshot.

status

enum

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

Enum type. Can be one of the following:
CREATING Snapshot creation is in progress.
DELETING Snapshot is currently being deleted.
FAILED Snapshot creation failed.
READY Snapshot has been created successfully.
UPLOADING Snapshot is being uploaded.
storageBytes

string (int64 format)

[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

storageBytesStatus

enum

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

Enum type. Can be one of the following:
UPDATING (No description provided)
UP_TO_DATE (No description provided)
storageLocations[]

string

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

SnapshotList

Contains a list of Snapshot resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Snapshot)

A list of Snapshot resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SourceDiskEncryptionKey

(No description provided)
Fields
diskEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

sourceDisk

string

URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk

SourceInstanceParams

A specification of the parameters to use when creating the instance template from a source instance.
Fields
diskConfigs[]

object (DiskInstantiationConfig)

Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.

SourceInstanceProperties

DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.
Fields
canIpForward

boolean

Enables instances created based on this machine image 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, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

deletionProtection

boolean

Whether the instance created from this machine image should be protected against deletion.

description

string

An optional text description for the instances that are created from this machine image.

disks[]

object (SavedAttachedDisk)

An array of disks that are associated with the instances that are created from this machine image.

guestAccelerators[]

object (AcceleratorConfig)

A list of guest accelerator cards' type and count to use for instances created from this machine image.

keyRevocationActionType

enum

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.

Enum type. Can be one of the following:
KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED Default value. This value is unused.
NONE Indicates user chose no operation.
STOP Indicates user chose to opt for VM shutdown on key revocation.
labels

map (key: string, value: string)

Labels to apply to instances that are created from this machine image.

machineType

string

The machine type to use for instances that are created from this machine image.

metadata

object (Metadata)

The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

metadata.items.key

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.

metadata.items.value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

minCpuPlatform

string

Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

networkInterfaces[]

object (NetworkInterface)

An array of network access configurations for this interface.

scheduling

object (Scheduling)

Specifies the scheduling options for the instances that are created from this machine image.

serviceAccounts[]

object (ServiceAccount)

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.

tags

object (Tags)

A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

SslCertificate

Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * Global * Regional The sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers The regionSslCertificates are used by internal HTTPS load balancers. Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.
Fields
certificate

string

A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

expireTime

string

[Output Only] Expire time of the certificate. RFC3339

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

managed

object (SslCertificateManagedSslCertificate)

Configuration and status of a managed SSL certificate.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

privateKey

string

A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

region

string

[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

selfLink

string

[Output only] Server-defined URL for the resource.

selfManaged

object (SslCertificateSelfManagedSslCertificate)

Configuration and status of a self-managed SSL certificate.

subjectAlternativeNames[]

string

[Output Only] Domains associated with the certificate via Subject Alternative Name.

type

enum

(Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.

Enum type. Can be one of the following:
MANAGED Google-managed SSLCertificate.
SELF_MANAGED Certificate uploaded by user.
TYPE_UNSPECIFIED (No description provided)

SslCertificateAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (SslCertificatesScopedList))

A list of SslCertificatesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SslCertificateList

Contains a list of SslCertificate resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (SslCertificate)

A list of SslCertificate resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SslCertificateManagedSslCertificate

Configuration and status of a managed SSL certificate.
Fields
domainStatus

map (key: string, value: string)

[Output only] Detailed statuses of the domains specified for managed certificate resource.

domains[]

string

The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the maximum number of domains per Google-managed SSL certificate.

status

enum

[Output only] Status of the managed certificate resource.

Enum type. Can be one of the following:
ACTIVE The certificate management is working, and a certificate has been provisioned.
MANAGED_CERTIFICATE_STATUS_UNSPECIFIED (No description provided)
PROVISIONING The certificate management is working. GCP will attempt to provision the first certificate.
PROVISIONING_FAILED Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.
PROVISIONING_FAILED_PERMANENTLY Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won't be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.
RENEWAL_FAILED Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field.

SslCertificateSelfManagedSslCertificate

Configuration and status of a self-managed SSL certificate.
Fields
certificate

string

A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

privateKey

string

A write-only private key in PEM format. Only insert requests will include this field.

SslCertificatesScopedList

(No description provided)
Fields
sslCertificates[]

object (SslCertificate)

List of SslCertificates contained in this scope.

warning

object

Informational warning which replaces the list of backend services when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SslPoliciesAggregatedList

(No description provided)
Fields
etag

string

(No description provided)

id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (SslPoliciesScopedList))

A list of SslPoliciesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SslPoliciesList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (SslPolicy)

A list of SslPolicy resources.

kind

string

[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SslPoliciesListAvailableFeaturesResponse

(No description provided)
Fields
features[]

string

(No description provided)

SslPoliciesScopedList

(No description provided)
Fields
sslPolicies[]

object (SslPolicy)

A list of SslPolicies contained in this scope.

warning

object

Informational warning which replaces the list of SSL policies when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SslPolicy

Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

customFeatures[]

string

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

description

string

An optional description of this resource. Provide this property when you create the resource.

enabledFeatures[]

string

[Output Only] The list of features enabled in the SSL policy.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

minTlsVersion

enum

The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.

Enum type. Can be one of the following:
TLS_1_0 TLS 1.0
TLS_1_1 TLS 1.1
TLS_1_2 TLS 1.2
name

string

Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

profile

enum

Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.

Enum type. Can be one of the following:
COMPATIBLE Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.
CUSTOM Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.
MODERN Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.
RESTRICTED Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements.
region

string

[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.

selfLink

string

[Output Only] Server-defined URL for the resource.

warnings[]

object

[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

warnings.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warnings.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warnings.data.key

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).

warnings.data.value

string

[Output Only] A warning data value corresponding to the key.

warnings.message

string

[Output Only] A human-readable description of the warning code.

SslPolicyReference

(No description provided)
Fields
sslPolicy

string

URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.

StatefulPolicy

(No description provided)
Fields
preservedState

object (StatefulPolicyPreservedState)

(No description provided)

StatefulPolicyPreservedState

Configuration of preserved resources.
Fields
disks

map (key: string, value: object (StatefulPolicyPreservedStateDiskDevice))

Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.

StatefulPolicyPreservedStateDiskDevice

(No description provided)
Fields
autoDelete

enum

These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.

Enum type. Can be one of the following:
NEVER (No description provided)
ON_PERMANENT_INSTANCE_DELETION (No description provided)

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Fields
code

integer (int32 format)

The status code, which should be an enum value of google.rpc.Code.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Subnetwork

Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.

enableFlowLogs

boolean

Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

externalIpv6Prefix

string

The external IPv6 address range that is owned by this subnetwork.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.

gatewayAddress

string

[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

internalIpv6Prefix

string

[Output Only] The internal IPv6 address range that is assigned to this subnetwork.

ipCidrRange

string

The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

ipv6AccessType

enum

The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.

Enum type. Can be one of the following:
EXTERNAL VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.
INTERNAL VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network.
ipv6CidrRange

string

[Output Only] This field is for internal use.

kind

string

[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

logConfig

object (SubnetworkLogConfig)

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

name

string

The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

string

The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.

privateIpGoogleAccess

boolean

Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.

privateIpv6GoogleAccess

enum

This field is for internal use. This field can be both set at resource creation time and updated using patch.

Enum type. Can be one of the following:
DISABLE_GOOGLE_ACCESS Disable private IPv6 access to/from Google services.
ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE Bidirectional private IPv6 access to/from Google services.
ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE Outbound private IPv6 access from VMs in this subnet to Google services.
purpose

enum

The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

Enum type. Can be one of the following:
INTERNAL_HTTPS_LOAD_BALANCER Subnet reserved for Internal HTTP(S) Load Balancing.
PRIVATE Regular user created or automatically created subnet.
PRIVATE_RFC_1918 Regular user created or automatically created subnet.
PRIVATE_SERVICE_CONNECT Subnetworks created for Private Service Connect in the producer network.
REGIONAL_MANAGED_PROXY Subnetwork used for Regional Internal/External HTTP(S) Load Balancing.
region

string

URL of the region where the Subnetwork resides. This field can be set only at resource creation time.

role

enum

The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.

Enum type. Can be one of the following:
ACTIVE The ACTIVE subnet that is currently used.
BACKUP The BACKUP subnet that could be promoted to ACTIVE.
secondaryIpRanges[]

object (SubnetworkSecondaryRange)

An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.

selfLink

string

[Output Only] Server-defined URL for the resource.

stackType

enum

The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.

Enum type. Can be one of the following:
IPV4_IPV6 New VMs in this subnet can have both IPv4 and IPv6 addresses.
IPV4_ONLY New VMs in this subnet will only be assigned IPv4 addresses.
state

enum

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY

Enum type. Can be one of the following:
DRAINING Subnetwork is being drained.
READY Subnetwork is ready for use.

SubnetworkAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (SubnetworksScopedList))

A list of SubnetworksScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SubnetworkList

Contains a list of Subnetwork resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Subnetwork)

A list of Subnetwork resources.

kind

string

[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SubnetworkLogConfig

The available logging options for this subnetwork.
Fields
aggregationInterval

enum

Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.

Enum type. Can be one of the following:
INTERVAL_10_MIN (No description provided)
INTERVAL_15_MIN (No description provided)
INTERVAL_1_MIN (No description provided)
INTERVAL_30_SEC (No description provided)
INTERVAL_5_MIN (No description provided)
INTERVAL_5_SEC (No description provided)
enable

boolean

Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. Flow logging isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

filterExpr

string

Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.

flowSampling

number (float format)

Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.

metadata

enum

Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA.

Enum type. Can be one of the following:
CUSTOM_METADATA (No description provided)
EXCLUDE_ALL_METADATA (No description provided)
INCLUDE_ALL_METADATA (No description provided)
metadataFields[]

string

Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.

SubnetworkSecondaryRange

Represents a secondary IP range of a subnetwork.
Fields
ipCidrRange

string

The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.

rangeName

string

The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.

SubnetworksExpandIpCidrRangeRequest

(No description provided)
Fields
ipCidrRange

string

The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.

SubnetworksScopedList

(No description provided)
Fields
subnetworks[]

object (Subnetwork)

A list of subnetworks contained in this scope.

warning

object

An informational warning that appears when the list of addresses is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

SubnetworksSetPrivateIpGoogleAccessRequest

(No description provided)
Fields
privateIpGoogleAccess

boolean

(No description provided)

Subsetting

Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
Fields
policy

enum

(No description provided)

Enum type. Can be one of the following:
CONSISTENT_HASH_SUBSETTING Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled.
NONE No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends.

TCPHealthCheck

(No description provided)
Fields
port

integer (int32 format)

The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.

portName

string

Not supported.

portSpecification

enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.

Enum type. Can be one of the following:
USE_FIXED_PORT The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
USE_NAMED_PORT Not supported.
USE_SERVING_PORT For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.
proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)
request

string

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

response

string

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

Tags

A set of instance tags.
Fields
fingerprint

string (bytes format)

Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance.

items[]

string

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

TargetGrpcProxy

Represents a Target gRPC Proxy resource. A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Only global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can reference a target gRPC proxy. The target gRPC Proxy references a URL map that specifies how traffic is routed to gRPC backend services.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy.

id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.

kind

string

[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

selfLink

string

[Output Only] Server-defined URL for the resource.

selfLinkWithId

string

[Output Only] Server-defined URL with id for the resource.

urlMap

string

URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

validateForProxyless

boolean

If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

TargetGrpcProxyList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (TargetGrpcProxy)

A list of TargetGrpcProxy resources.

kind

string

[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetHttpProxiesScopedList

(No description provided)
Fields
targetHttpProxies[]

object (TargetHttpProxy)

A list of TargetHttpProxies contained in this scope.

warning

object

Informational warning which replaces the list of backend services when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetHttpProxy

Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * Global * Regional A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.

httpKeepAliveTimeoutSec

integer (int32 format)

Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

proxyBind

boolean

This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.

region

string

[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.

selfLink

string

[Output Only] Server-defined URL for the resource.

urlMap

string

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

TargetHttpProxyAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (TargetHttpProxiesScopedList))

A list of TargetHttpProxiesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

TargetHttpProxyList

A list of TargetHttpProxy resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (TargetHttpProxy)

A list of TargetHttpProxy resources.

kind

string

Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetHttpsProxiesScopedList

(No description provided)
Fields
targetHttpsProxies[]

object (TargetHttpsProxy)

A list of TargetHttpsProxies contained in this scope.

warning

object

Informational warning which replaces the list of backend services when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetHttpsProxiesSetCertificateMapRequest

(No description provided)
Fields
certificateMap

string

URL of the Certificate Map to associate with this TargetHttpsProxy. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

TargetHttpsProxiesSetQuicOverrideRequest

(No description provided)
Fields
quicOverride

enum

QUIC policy for the TargetHttpsProxy resource.

Enum type. Can be one of the following:
DISABLE The load balancer will not attempt to negotiate QUIC with clients.
ENABLE The load balancer will attempt to negotiate QUIC with clients.
NONE No overrides to the default QUIC policy. This option is implicit if no QUIC override has been specified in the request.

TargetHttpsProxiesSetSslCertificatesRequest

(No description provided)
Fields
sslCertificates[]

string

New set of SslCertificate resources to associate with this TargetHttpsProxy resource. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

TargetHttpsProxy

Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * Global * Regional A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.
Fields
authorizationPolicy

string

Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact.

certificateMap

string

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

httpKeepAliveTimeoutSec

integer (int32 format)

Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

proxyBind

boolean

This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.

quicOverride

enum

Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied.

Enum type. Can be one of the following:
DISABLE The load balancer will not attempt to negotiate QUIC with clients.
ENABLE The load balancer will attempt to negotiate QUIC with clients.
NONE No overrides to the default QUIC policy. This option is implicit if no QUIC override has been specified in the request.
region

string

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

selfLink

string

[Output Only] Server-defined URL for the resource.

serverTlsPolicy

string

Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.

sslCertificates[]

string

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

sslPolicy

string

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

urlMap

string

A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map

TargetHttpsProxyAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (TargetHttpsProxiesScopedList))

A list of TargetHttpsProxiesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetHttpsProxyList

Contains a list of TargetHttpsProxy resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (TargetHttpsProxy)

A list of TargetHttpsProxy resources.

kind

string

Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetInstance

Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

instance

string

A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance

kind

string

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

natPolicy

enum

Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.

Enum type. Can be one of the following:
NO_NAT No NAT performed.
network

string

The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.

selfLink

string

[Output Only] Server-defined URL for the resource.

zone

string

[Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

TargetInstanceAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (TargetInstancesScopedList))

A list of TargetInstance resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetInstanceList

Contains a list of TargetInstance resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (TargetInstance)

A list of TargetInstance resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetInstancesScopedList

(No description provided)
Fields
targetInstances[]

object (TargetInstance)

A list of target instances contained in this scope.

warning

object

Informational warning which replaces the list of addresses when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetPool

Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.
Fields
backupPool

string

The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

failoverRatio

number (float format)

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

healthChecks[]

string

The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

instances[]

string

A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

kind

string

[Output Only] Type of the resource. Always compute#targetPool for target pools.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region

string

[Output Only] URL of the region where the target pool resides.

selfLink

string

[Output Only] Server-defined URL for the resource.

sessionAffinity

enum

Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

Enum type. Can be one of the following:
CLIENT_IP 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.
CLIENT_IP_NO_DESTINATION 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.
CLIENT_IP_PORT_PROTO 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
CLIENT_IP_PROTO 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
GENERATED_COOKIE Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
HEADER_FIELD The hash is based on a user specified header field.
HTTP_COOKIE The hash is based on a user provided cookie.
NONE No session affinity. Connections from the same client IP may go to any instance in the pool.

TargetPoolAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (TargetPoolsScopedList))

A list of TargetPool resources.

kind

string

[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetPoolInstanceHealth

(No description provided)
Fields
healthStatus[]

object (HealthStatus)

(No description provided)

kind

string

[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.

TargetPoolList

Contains a list of TargetPool resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (TargetPool)

A list of TargetPool resources.

kind

string

[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetPoolsAddHealthCheckRequest

(No description provided)
Fields
healthChecks[]

object (HealthCheckReference)

The HttpHealthCheck to add to the target pool.

TargetPoolsAddInstanceRequest

(No description provided)
Fields
instances[]

object (InstanceReference)

A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone /instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name

TargetPoolsRemoveHealthCheckRequest

(No description provided)
Fields
healthChecks[]

object (HealthCheckReference)

Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project /global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check

TargetPoolsRemoveInstanceRequest

(No description provided)
Fields
instances[]

object (InstanceReference)

URLs of the instances to be removed from target pool.

TargetPoolsScopedList

(No description provided)
Fields
targetPools[]

object (TargetPool)

A list of target pools contained in this scope.

warning

object

Informational warning which replaces the list of addresses when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetReference

(No description provided)
Fields
target

string

(No description provided)

TargetSslProxiesSetBackendServiceRequest

(No description provided)
Fields
service

string

The URL of the new BackendService resource for the targetSslProxy.

TargetSslProxiesSetCertificateMapRequest

(No description provided)
Fields
certificateMap

string

URL of the Certificate Map to associate with this TargetSslProxy. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

TargetSslProxiesSetProxyHeaderRequest

(No description provided)
Fields
proxyHeader

enum

The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)

TargetSslProxiesSetSslCertificatesRequest

(No description provided)
Fields
sslCertificates[]

string

New set of URLs to SslCertificate resources to associate with this TargetSslProxy. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

TargetSslProxy

Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies.
Fields
certificateMap

string

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)
selfLink

string

[Output Only] Server-defined URL for the resource.

service

string

URL to the BackendService resource.

sslCertificates[]

string

URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

sslPolicy

string

URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.

TargetSslProxyList

Contains a list of TargetSslProxy resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (TargetSslProxy)

A list of TargetSslProxy resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetTcpProxiesScopedList

(No description provided)
Fields
targetTcpProxies[]

object (TargetTcpProxy)

A list of TargetTcpProxies contained in this scope.

warning

object

Informational warning which replaces the list of backend services when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetTcpProxiesSetBackendServiceRequest

(No description provided)
Fields
service

string

The URL of the new BackendService resource for the targetTcpProxy.

TargetTcpProxiesSetProxyHeaderRequest

(No description provided)
Fields
proxyHeader

enum

The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)

TargetTcpProxy

Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

proxyBind

boolean

This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.

proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Enum type. Can be one of the following:
NONE (No description provided)
PROXY_V1 (No description provided)
region

string

[Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.

selfLink

string

[Output Only] Server-defined URL for the resource.

service

string

URL to the BackendService resource.

TargetTcpProxyAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (TargetTcpProxiesScopedList))

A list of TargetTcpProxiesScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#targetTcpProxyAggregatedList for lists of Target TCP Proxies.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetTcpProxyList

Contains a list of TargetTcpProxy resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (TargetTcpProxy)

A list of TargetTcpProxy resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetVpnGateway

Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

forwardingRules[]

string

[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

string

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

region

string

[Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

status

enum

[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.

Enum type. Can be one of the following:
CREATING (No description provided)
DELETING (No description provided)
FAILED (No description provided)
READY (No description provided)
tunnels[]

string

[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.

TargetVpnGatewayAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (TargetVpnGatewaysScopedList))

A list of TargetVpnGateway resources.

kind

string

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetVpnGatewayList

Contains a list of TargetVpnGateway resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (TargetVpnGateway)

A list of TargetVpnGateway resources.

kind

string

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TargetVpnGatewaysScopedList

(No description provided)
Fields
targetVpnGateways[]

object (TargetVpnGateway)

[Output Only] A list of target VPN gateways contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of addresses when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

TestFailure

(No description provided)
Fields
actualOutputUrl

string

The actual output URL evaluated by a load balancer containing the scheme, host, path and query parameters.

actualRedirectResponseCode

integer (int32 format)

Actual HTTP status code for rule with urlRedirect calculated by load balancer

actualService

string

BackendService or BackendBucket returned by load balancer.

expectedOutputUrl

string

The expected output URL evaluated by a load balancer containing the scheme, host, path and query parameters.

expectedRedirectResponseCode

integer (int32 format)

Expected HTTP status code for rule with urlRedirect calculated by load balancer

expectedService

string

Expected BackendService or BackendBucket resource the given URL should be mapped to.

headers[]

object (UrlMapTestHeader)

HTTP headers of the request.

host

string

Host portion of the URL.

path

string

Path portion including query parameters in the URL.

TestPermissionsRequest

(No description provided)
Fields
permissions[]

string

The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.

TestPermissionsResponse

(No description provided)
Fields
permissions[]

string

A subset of TestPermissionsRequest.permissions that the caller is allowed.

Uint128

(No description provided)
Fields
high

string (uint64 format)

(No description provided)

low

string (uint64 format)

(No description provided)

UrlMap

Represents a URL Map resource. Compute Engine has two URL Map resources: * Global * Regional A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

defaultRouteAction

object (HttpRouteAction)

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

defaultService

string

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

defaultUrlRedirect

object (HttpRedirectAction)

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

description

string

An optional description of this resource. Provide this property when you create the resource.

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

headerAction

object (HttpHeaderAction)

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

hostRules[]

object (HostRule)

The list of host rules to use against the URL.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

pathMatchers[]

object (PathMatcher)

The list of named PathMatchers to use against the URL.

region

string

[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLink

string

[Output Only] Server-defined URL for the resource.

tests[]

object (UrlMapTest)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

UrlMapList

Contains a list of UrlMap resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (UrlMap)

A list of UrlMap resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

UrlMapReference

(No description provided)
Fields
urlMap

string

(No description provided)

UrlMapTest

Message for the expected URL mappings.
Fields
description

string

Description of this test case.

expectedOutputUrl

string

The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

expectedRedirectResponseCode

integer (int32 format)

For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.

headers[]

object (UrlMapTestHeader)

HTTP headers for this request. If headers contains a host header, then host must also match the header value.

host

string

Host portion of the URL. If headers contains a host header, then host must also match the header value.

path

string

Path portion of the URL.

service

string

Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.

UrlMapTestHeader

HTTP headers used in UrlMapTests.
Fields
name

string

Header name.

value

string

Header value.

UrlMapValidationResult

Message representing the validation result for a UrlMap.
Fields
loadErrors[]

string

(No description provided)

loadSucceeded

boolean

Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.

testFailures[]

object (TestFailure)

(No description provided)

testPassed

boolean

If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

UrlMapsAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (UrlMapsScopedList))

A list of UrlMapsScopedList resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

UrlMapsScopedList

(No description provided)
Fields
urlMaps[]

object (UrlMap)

A list of UrlMaps contained in this scope.

warning

object

Informational warning which replaces the list of backend services when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

UrlMapsValidateRequest

(No description provided)
Fields
loadBalancingSchemes[]

string

Specifies the load balancer type(s) this validation request is for. Use EXTERNAL_MANAGED for HTTP/HTTPS External Global Load Balancer with Advanced Traffic Management. Use EXTERNAL for Classic HTTP/HTTPS External Global Load Balancer. Other load balancer types are not supported. For more information, refer to Choosing a load balancer. If unspecified, the load balancing scheme will be inferred from the backend service resources this URL map references. If that can not be inferred (for example, this URL map only references backend buckets, or this Url map is for rewrites and redirects only and doesn't reference any backends), EXTERNAL will be used as the default type. If specified, the scheme(s) must not conflict with the load balancing scheme of the backend service resources this Url map references.

resource

object (UrlMap)

Content of the UrlMap to be validated.

UrlMapsValidateResponse

(No description provided)
Fields
result

object (UrlMapValidationResult)

(No description provided)

UrlRewrite

The spec for modifying the path before sending the request to the matched backend service.
Fields
hostRewrite

string

Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.

pathPrefixRewrite

string

Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.

pathTemplateRewrite

string

If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or {var=}. For example, a path_template_match of /static/{format=} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.

UsableSubnetwork

Subnetwork which the current user has compute.subnetworks.use permission on.
Fields
externalIpv6Prefix

string

[Output Only] The external IPv6 address range that is assigned to this subnetwork.

internalIpv6Prefix

string

[Output Only] The internal IPv6 address range that is assigned to this subnetwork.

ipCidrRange

string

The range of internal addresses that are owned by this subnetwork.

ipv6AccessType

enum

The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.

Enum type. Can be one of the following:
EXTERNAL VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.
INTERNAL VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network.
network

string

Network URL.

purpose

enum

The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

Enum type. Can be one of the following:
INTERNAL_HTTPS_LOAD_BALANCER Subnet reserved for Internal HTTP(S) Load Balancing.
PRIVATE Regular user created or automatically created subnet.
PRIVATE_RFC_1918 Regular user created or automatically created subnet.
PRIVATE_SERVICE_CONNECT Subnetworks created for Private Service Connect in the producer network.
REGIONAL_MANAGED_PROXY Subnetwork used for Regional Internal/External HTTP(S) Load Balancing.
role

enum

The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.

Enum type. Can be one of the following:
ACTIVE The ACTIVE subnet that is currently used.
BACKUP The BACKUP subnet that could be promoted to ACTIVE.
secondaryIpRanges[]

object (UsableSubnetworkSecondaryRange)

Secondary IP ranges.

stackType

enum

The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.

Enum type. Can be one of the following:
IPV4_IPV6 New VMs in this subnet can have both IPv4 and IPv6 addresses.
IPV4_ONLY New VMs in this subnet will only be assigned IPv4 addresses.
subnetwork

string

Subnetwork URL.

UsableSubnetworkSecondaryRange

Secondary IP range of a usable subnetwork.
Fields
ipCidrRange

string

The range of IP addresses belonging to this subnetwork secondary range.

rangeName

string

The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.

UsableSubnetworksAggregatedList

(No description provided)
Fields
id

string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items[]

object (UsableSubnetwork)

[Output] A list of usable subnetwork URLs.

kind

string

[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. In special cases listUsable may return 0 subnetworks and nextPageToken which still should be used to get the next page of results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

UsageExportLocation

The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
Fields
bucketName

string

The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.

reportNamePrefix

string

An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.

VmEndpointNatMappings

Contain information of Nat mapping for a VM endpoint (i.e., NIC).
Fields
instanceName

string

Name of the VM instance which the endpoint belongs to

interfaceNatMappings[]

object (VmEndpointNatMappingsInterfaceNatMappings)

(No description provided)

VmEndpointNatMappingsInterfaceNatMappings

Contain information of Nat mapping for an interface of this endpoint.
Fields
drainNatIpPortRanges[]

string

List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

natIpPortRanges[]

string

A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

numTotalDrainNatPorts

integer (int32 format)

Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges.

numTotalNatPorts

integer (int32 format)

Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges.

ruleMappings[]

object (VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings)

Information about mappings provided by rules in this NAT.

sourceAliasIpRange

string

Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24".

sourceVirtualIp

string

Primary IP of the VM for this NIC.

VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings

Contains information of NAT Mappings provided by a NAT Rule.
Fields
drainNatIpPortRanges[]

string

List of all drain IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

natIpPortRanges[]

string

A list of all IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

numTotalDrainNatPorts

integer (int32 format)

Total number of drain ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field drain_nat_ip_port_ranges.

numTotalNatPorts

integer (int32 format)

Total number of ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field nat_ip_port_ranges.

ruleNumber

integer (int32 format)

Rule number of the NAT Rule.

VmEndpointNatMappingsList

Contains a list of VmEndpointNatMappings.
Fields
id

string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

result[]

object (VmEndpointNatMappings)

[Output Only] A list of Nat mapping information of VM endpoints.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

VpnGateway

Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

string

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

region

string

[Output Only] URL of the region where the VPN gateway resides.

selfLink

string

[Output Only] Server-defined URL for the resource.

stackType

enum

The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.

Enum type. Can be one of the following:
IPV4_IPV6 Enable VPN gateway with both IPv4 and IPv6 protocols.
IPV4_ONLY Enable VPN gateway with only IPv4 protocol.
vpnInterfaces[]

object (VpnGatewayVpnGatewayInterface)

The list of VPN interfaces associated with this VPN gateway.

VpnGatewayAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (VpnGatewaysScopedList))

A list of VpnGateway resources.

kind

string

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

VpnGatewayList

Contains a list of VpnGateway resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (VpnGateway)

A list of VpnGateway resources.

kind

string

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

VpnGatewayStatus

(No description provided)
Fields
vpnConnections[]

object (VpnGatewayStatusVpnConnection)

List of VPN connection for this VpnGateway.

VpnGatewayStatusHighAvailabilityRequirementState

Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway.
Fields
state

enum

Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.

Enum type. Can be one of the following:
CONNECTION_REDUNDANCY_MET VPN tunnels are configured with adequate redundancy from Cloud VPN gateway to the peer VPN gateway. For both GCP-to-non-GCP and GCP-to-GCP connections, the adequate redundancy is a pre-requirement for users to get 99.99% availability on GCP side; please note that for any connection, end-to-end 99.99% availability is subject to proper configuration on the peer VPN gateway.
CONNECTION_REDUNDANCY_NOT_MET VPN tunnels are not configured with adequate redundancy from the Cloud VPN gateway to the peer gateway
unsatisfiedReason

enum

Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.

Enum type. Can be one of the following:
INCOMPLETE_TUNNELS_COVERAGE (No description provided)

VpnGatewayStatusTunnel

Contains some information about a VPN tunnel.
Fields
localGatewayInterface

integer (uint32 format)

The VPN gateway interface this VPN tunnel is associated with.

peerGatewayInterface

integer (uint32 format)

The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or a Google Cloud VPN gateway.

tunnelUrl

string

URL reference to the VPN tunnel.

VpnGatewayStatusVpnConnection

A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be an external VPN gateway or a Google Cloud VPN gateway.
Fields
peerExternalGateway

string

URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

peerGcpGateway

string

URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

state

object (VpnGatewayStatusHighAvailabilityRequirementState)

HighAvailabilityRequirementState for the VPN connection.

tunnels[]

object (VpnGatewayStatusTunnel)

List of VPN tunnels that are in this VPN connection.

VpnGatewayVpnGatewayInterface

A VPN gateway interface.
Fields
id

integer (uint32 format)

[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.

interconnectAttachment

string

URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.

ipAddress

string

[Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.

VpnGatewaysGetStatusResponse

(No description provided)
Fields
result

object (VpnGatewayStatus)

(No description provided)

VpnGatewaysScopedList

(No description provided)
Fields
vpnGateways[]

object (VpnGateway)

[Output Only] A list of VPN gateways contained in this scope.

warning

object

[Output Only] Informational warning which replaces the list of addresses when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

VpnTunnel

Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.
Fields
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

description

string

An optional description of this resource. Provide this property when you create the resource.

detailedStatus

string

[Output Only] Detailed status message for the VPN tunnel.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

ikeVersion

integer (int32 format)

IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.

kind

string

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

localTrafficSelector[]

string

Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

peerExternalGateway

string

URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.

peerExternalGatewayInterface

integer (int32 format)

The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.

peerGcpGateway

string

URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.

peerIp

string

IP address of the peer VPN gateway. Only IPv4 is supported.

region

string

[Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

remoteTrafficSelector[]

string

Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.

router

string

URL of the router resource to be used for dynamic routing.

selfLink

string

[Output Only] Server-defined URL for the resource.

sharedSecret

string

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

sharedSecretHash

string

Hash of the shared secret.

status

enum

[Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.

Enum type. Can be one of the following:
ALLOCATING_RESOURCES Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
AUTHORIZATION_ERROR Auth error (e.g. bad shared secret).
DEPROVISIONING Resources is being deallocated for the VPN tunnel.
ESTABLISHED Secure session is successfully established with peer VPN.
FAILED Tunnel creation has failed and the tunnel is not ready to be used.
FIRST_HANDSHAKE Successful first handshake with peer VPN.
NEGOTIATION_FAILURE Handshake failed.
NETWORK_ERROR Deprecated, replaced by NO_INCOMING_PACKETS
NO_INCOMING_PACKETS No incoming packets from peer
PROVISIONING Resource is being allocated for the VPN tunnel.
REJECTED Tunnel configuration was rejected, can be result of being denylisted.
STOPPED Tunnel is stopped due to its Forwarding Rules being deleted.
WAITING_FOR_FULL_CONFIG Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
targetVpnGateway

string

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

vpnGateway

string

URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.

vpnGatewayInterface

integer (int32 format)

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

VpnTunnelAggregatedList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items

map (key: string, value: object (VpnTunnelsScopedList))

A list of VpnTunnelsScopedList resources.

kind

string

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

unreachables[]

string

[Output Only] Unreachable resources.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

VpnTunnelList

Contains a list of VpnTunnel resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (VpnTunnel)

A list of VpnTunnel resources.

kind

string

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

VpnTunnelsScopedList

(No description provided)
Fields
vpnTunnels[]

object (VpnTunnel)

A list of VPN tunnels contained in this scope.

warning

object

Informational warning which replaces the list of addresses when the list is empty.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

WafExpressionSet

(No description provided)
Fields
aliases[]

string

A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set.

expressions[]

object (WafExpressionSetExpression)

List of available expressions.

id

string

Google specified expression set ID. The format should be: - E.g. XSS-20170329 required

WafExpressionSetExpression

(No description provided)
Fields
id

string

Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required

sensitivity

integer (int32 format)

The sensitivity value associated with the WAF rule ID. This corresponds to the ModSecurity paranoia level, ranging from 1 to 4. 0 is reserved for opt-in only rules.

WeightedBackendService

In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService
Fields
backendService

string

The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.

headerAction

object (HttpHeaderAction)

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

weight

integer (uint32 format)

Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000.

XpnHostList

(No description provided)
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Project)

[Output Only] A list of shared VPC host project URLs.

kind

string

[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

XpnResourceId

Service resource (a.k.a service project) ID.
Fields
id

string

The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678).

type

enum

The type of the service resource.

Enum type. Can be one of the following:
PROJECT (No description provided)
XPN_RESOURCE_TYPE_UNSPECIFIED (No description provided)

Zone

Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones.
Fields
availableCpuPlatforms[]

string

[Output Only] Available cpu/platform selections for the zone.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated

object (DeprecationStatus)

[Output Only] The deprecation status associated with this zone.

description

string

[Output Only] Textual description of the resource.

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

string

[Output Only] Type of the resource. Always compute#zone for zones.

name

string

[Output Only] Name of the resource.

region

string

[Output Only] Full URL reference to the region which hosts the zone.

selfLink

string

[Output Only] Server-defined URL for the resource.

status

enum

[Output Only] Status of the zone, either UP or DOWN.

Enum type. Can be one of the following:
DOWN (No description provided)
UP (No description provided)
supportsPzs

boolean

[Output Only] Reserved for future use.

ZoneList

Contains a list of zone resources.
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object (Zone)

A list of Zone resources.

kind

string

Type of resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Enum type. Can be one of the following:
CLEANUP_FAILED Warning about failed cleanup of transient changes made by a failed operation.
DEPRECATED_RESOURCE_USED A link to a deprecated resource was created.
DEPRECATED_TYPE_USED When deploying and at least one of the resources has a type marked as deprecated
DISK_SIZE_LARGER_THAN_IMAGE_SIZE The user created a boot disk that is larger than image size.
EXPERIMENTAL_TYPE_USED When deploying and at least one of the resources has a type marked as experimental
EXTERNAL_API_WARNING Warning that is present in an external api call
FIELD_VALUE_OVERRIDEN Warning that value of a field has been overridden. Deprecated unused field.
INJECTED_KERNELS_DEPRECATED The operation involved use of an injected kernel, which is deprecated.
INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.
LARGE_DEPLOYMENT_WARNING When deploying a deployment with a exceedingly large number of resources
LIST_OVERHEAD_QUOTA_EXCEED Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.
MISSING_TYPE_DEPENDENCY A resource depends on a missing type
NEXT_HOP_ADDRESS_NOT_ASSIGNED The route's nextHopIp address is not assigned to an instance on the network.
NEXT_HOP_CANNOT_IP_FORWARD The route's next hop instance cannot ip forward.
NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.
NEXT_HOP_INSTANCE_NOT_FOUND The route's nextHopInstance URL refers to an instance that does not exist.
NEXT_HOP_INSTANCE_NOT_ON_NETWORK The route's nextHopInstance URL refers to an instance that is not on the same network as the route.
NEXT_HOP_NOT_RUNNING The route's next hop instance does not have a status of RUNNING.
NOT_CRITICAL_ERROR Error which is not critical. We decided to continue the process despite the mentioned error.
NO_RESULTS_ON_PAGE No results are present on a particular list page.
PARTIAL_SUCCESS Success is reported, but some results may be missing due to errors
REQUIRED_TOS_AGREEMENT The user attempted to use a resource that requires a TOS they have not accepted.
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING Warning that a resource is in use.
RESOURCE_NOT_DELETED One or more of the resources set to auto-delete could not be deleted because they were in use.
SCHEMA_VALIDATION_IGNORED When a resource schema validation is ignored.
SINGLE_INSTANCE_PROPERTY_TEMPLATE Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.
UNDECLARED_PROPERTIES When undeclared properties in the schema are present
UNREACHABLE A given scope cannot be reached.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

warning.data.key

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).

warning.data.value

string

[Output Only] A warning data value corresponding to the key.

warning.message

string

[Output Only] A human-readable description of the warning code.

ZoneSetLabelsRequest

(No description provided)
Fields
labelFingerprint

string (bytes format)

The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.

labels

map (key: string, value: string)

The labels to set for this resource.

ZoneSetPolicyRequest

(No description provided)
Fields
bindings[]

object (Binding)

Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

etag

string (bytes format)

Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

policy

object (Policy)

REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.