Home

GCP Compute Engine (version v1.*.*)

abandon_instances_in_instance_group_manager#

Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

You can specify a maximum of 1000 instances with this method per request.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

$body#

Type: object

{
  "instances" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

abandon_instances_in_region_instance_group_manager#

Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

You can specify a maximum of 1000 instances with this method per request.

Parameters

instanceGroupManager (required)#

Name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "instances" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_access_config_for_instance#

Adds an access config to an instance's network interface.

Parameters

instance (required)#

The instance name for this request.

Type: string

networkInterface (required)#

The name of the network interface to add to this instance.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

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

Type: object

{
  "natIP" : "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" : "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.\n\nIf an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.\n\nIf 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.",
  "kind" : "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
  "name" : "The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.",
  "publicPtrDomainName" : "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.",
  "setPublicPtr" : "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.",
  "type" : "The type of configuration. The default and only option is ONE_TO_ONE_NAT."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_health_check_to_target_pool#

Adds health check URLs to a target pool.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetPool (required)#

Name of the target pool to add a health check to.

Type: string

$body#

Type: object

{
  "healthChecks" : [ {
    "healthCheck" : "string"
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_instance_to_target_pool#

Adds an instance to a target pool.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetPool (required)#

Name of the TargetPool resource to add instances to.

Type: string

$body#

Type: object

{
  "instances" : [ {
    "instance" : "The URL for a specific instance."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_instances_to_instance_group#

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

Parameters

instanceGroup (required)#

The name of the instance group where you are adding instances.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the instance group is located.

Type: string

$body#

Type: object

{
  "instances" : [ {
    "instance" : "The URL for a specific instance."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_nodes_to_node_group#

Adds specified number of nodes to the node group.

Parameters

nodeGroup (required)#

Name of the NodeGroup resource.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "additionalNodeCount" : "Count of additional nodes to be added to the node group."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_peering_to_network#

Adds a peering to the specified network.

Parameters

network (required)#

Name of the network resource to add peering to.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "autoCreateRoutes" : "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" : "Name of the peering, which should conform to RFC1035.",
  "peerNetwork" : "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.",
  "networkPeering" : {
    "exchangeSubnetRoutes" : "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.",
    "autoCreateRoutes" : "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.",
    "name" : "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.",
    "state" : "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.",
    "exportCustomRoutes" : "Whether to export the custom routes to peer network.",
    "stateDetails" : "[Output Only] Details about the current state of the peering.",
    "importCustomRoutes" : "Whether to import the custom routes from peer network.",
    "network" : "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."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_resource_policy_to_disk#

Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

Parameters

disk (required)#

The disk name for this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "resourcePolicies" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_resource_policy_to_region_disk#

Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

Parameters

disk (required)#

The disk name for this request.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

$body#

Type: object

{
  "resourcePolicies" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_rule_to_security_policy#

Inserts a rule into a security policy.

Parameters

project (required)#

Project ID for this request.

Type: string

securityPolicy (required)#

Name of the security policy to update.

Type: string

$body#

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

Type: object

{
  "preview" : "If set to true, the specified action is not enforced.",
  "kind" : "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules",
  "match" : {
    "versionedExpr" : "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.",
    "config" : {
      "srcIpRanges" : [ "string" ]
    }
  },
  "action" : "The Action to preform when the client connection triggers the rule. Can currently be either \"allow\" or \"deny()\" where valid values for status are 403, 404, and 502.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "priority" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_signed_url_key_to_backend_bucket#

Adds a key for validating requests with signed URLs for this backend bucket.

Parameters

backendBucket (required)#

Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

Type: object

{
  "keyValue" : "128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.",
  "keyName" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

add_signed_url_key_to_backend_service#

Adds a key for validating requests with signed URLs for this backend service.

Parameters

backendService (required)#

Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

Type: object

{
  "keyValue" : "128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.",
  "keyName" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

attach_disk_to_instance#

Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.

Parameters

instance (required)#

The instance name for this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

An instance-attached disk resource.

Type: object

{
  "kind" : "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
  "index" : "[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.",
  "guestOsFeatures" : [ {
    "type" : "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options."
  } ],
  "source" : "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.\n\nIf desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.\n\nNote that for InstanceTemplate, specify the disk name, not the URL for the disk.",
  "interface" : "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported.",
  "type" : "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
  "deviceName" : "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.\n\nIf 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.",
  "initializeParams" : {
    "diskName" : "Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.",
    "sourceImageEncryptionKey" : {
      "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
      "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
      "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
    },
    "sourceSnapshotEncryptionKey" : {
      "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
      "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
      "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
    },
    "resourcePolicies" : [ "string" ],
    "description" : "An optional description. Provide this property when creating the disk.",
    "sourceSnapshot" : "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.\n\nTo create a disk with a snapshot that you created, specify the snapshot name in the following format:\nglobal/snapshots/my-backup\n\n\nIf the source snapshot is deleted later, this field will not be set.",
    "diskType" : "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:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard\n\n\nOther values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n- projects/project/zones/zone/diskTypes/diskType \n- zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.",
    "sourceImage" : "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.\n\nTo 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:\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the image name in the following format:\nglobal/images/my-custom-image\n\n\nYou 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:\nglobal/images/family/my-image-family\n\n\nIf the source image is deleted later, this field will not be set.",
    "diskSizeGb" : "Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB.",
    "labels" : "Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks."
  },
  "mode" : "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.",
  "licenses" : [ "string" ],
  "diskEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "autoDelete" : "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
  "boot" : "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

forceAttach#

Whether to force attach the disk even if it's currently attached to another instance.

Type: boolean

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

attach_network_endpoints_to_network_endpoint_group#

Attach a list of network endpoints to the specified network endpoint group.

Parameters

networkEndpointGroup (required)#

The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the network endpoint group is located. It should comply with RFC1035.

Type: string

$body#

Type: object

{
  "networkEndpoints" : [ {
    "instance" : "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.\n\nThe name must be 1-63 characters long, and comply with RFC1035.",
    "port" : "Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.",
    "ipAddress" : "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."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

create_snapshot_of_disk#

Creates a snapshot of a specified persistent disk.

Parameters

disk (required)#

Name of the persistent disk to snapshot.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

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. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==)

Type: object

{
  "sourceDisk" : "[Output Only] The source disk used to create this snapshot.",
  "sourceDiskId" : "[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.",
  "kind" : "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "labelFingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a snapshot.",
  "labels" : "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "licenses" : [ "string" ],
  "storageBytesStatus" : "[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.",
  "licenseCodes" : [ "int64" ],
  "snapshotEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "storageBytes" : "[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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "sourceDiskEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "storageLocations" : [ "string" ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "autoCreated" : "[Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk.",
  "diskSizeGb" : "[Output Only] Size of the snapshot, specified in GB.",
  "status" : "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

guestFlush#

[Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

Type: boolean

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

create_snapshot_of_region_disk#

Creates a snapshot of this regional disk.

Parameters

disk (required)#

Name of the regional persistent disk to snapshot.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

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. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==)

Type: object

{
  "sourceDisk" : "[Output Only] The source disk used to create this snapshot.",
  "sourceDiskId" : "[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.",
  "kind" : "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "labelFingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a snapshot.",
  "labels" : "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "licenses" : [ "string" ],
  "storageBytesStatus" : "[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.",
  "licenseCodes" : [ "int64" ],
  "snapshotEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "storageBytes" : "[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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "sourceDiskEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "storageLocations" : [ "string" ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "autoCreated" : "[Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk.",
  "diskSizeGb" : "[Output Only] Size of the snapshot, specified in GB.",
  "status" : "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_access_config_for_instance#

Deletes an access config from an instance's network interface.

Parameters

accessConfig (required)#

The name of the access config to delete.

Type: string

instance (required)#

The instance name for this request.

Type: string

networkInterface (required)#

The name of the network interface.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_address#

Deletes the specified address resource.

Parameters

address (required)#

Name of the address resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_autoscaler#

Deletes the specified autoscaler.

Parameters

autoscaler (required)#

Name of the autoscaler to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_backend_bucket#

Deletes the specified BackendBucket resource.

Parameters

backendBucket (required)#

Name of the BackendBucket resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_backend_service#

Deletes the specified BackendService resource.

Parameters

backendService (required)#

Name of the BackendService resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_disk#

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Parameters

disk (required)#

Name of the persistent disk to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_external_vpn_gateway#

Deletes the specified externalVpnGateway.

Parameters

externalVpnGateway (required)#

Name of the externalVpnGateways to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_firewall#

Deletes the specified firewall.

Parameters

firewall (required)#

Name of the firewall rule to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_forwarding_rule#

Deletes the specified ForwardingRule resource.

Parameters

forwardingRule (required)#

Name of the ForwardingRule resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_global_address#

Deletes the specified address resource.

Parameters

address (required)#

Name of the address resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_global_forwarding_rule#

Deletes the specified GlobalForwardingRule resource.

Parameters

forwardingRule (required)#

Name of the ForwardingRule resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_global_operation#

Deletes the specified Operations resource.

Parameters

operation (required)#

Name of the Operations resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_health_check#

Deletes the specified HealthCheck resource.

Parameters

healthCheck (required)#

Name of the HealthCheck resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_http_health_check#

Deletes the specified HttpHealthCheck resource.

Parameters

httpHealthCheck (required)#

Name of the HttpHealthCheck resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_https_health_check#

Deletes the specified HttpsHealthCheck resource.

Parameters

httpsHealthCheck (required)#

Name of the HttpsHealthCheck resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_image#

Deletes the specified image.

Parameters

image (required)#

Name of the image resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_instance#

Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

Parameters

instance (required)#

Name of the instance resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_instance_group#

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

Parameters

instanceGroup (required)#

The name of the instance group to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the instance group is located.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_instance_group_manager#

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

Parameters

instanceGroupManager (required)#

The name of the managed instance group to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_instance_template#

Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.

Parameters

instanceTemplate (required)#

The name of the instance template to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_instances_from_instance_group_manager#

Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

You can specify a maximum of 1000 instances with this method per request.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

$body#

Type: object

{
  "instances" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_instances_in_region_instance_group_manager#

Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

You can specify a maximum of 1000 instances with this method per request.

Parameters

instanceGroupManager (required)#

Name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "instances" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_interconnect#

Deletes the specified interconnect.

Parameters

interconnect (required)#

Name of the interconnect to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_interconnect_attachment#

Deletes the specified interconnect attachment.

Parameters

interconnectAttachment (required)#

Name of the interconnect attachment to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_license#

Deletes the specified license.

Parameters

license (required)#

Name of the license resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_network#

Deletes the specified network.

Parameters

network (required)#

Name of the network to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_network_endpoint_group#

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters

networkEndpointGroup (required)#

The name of the network endpoint group to delete. It should comply with RFC1035.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the network endpoint group is located. It should comply with RFC1035.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_node_group#

Deletes the specified NodeGroup resource.

Parameters

nodeGroup (required)#

Name of the NodeGroup resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_node_template#

Deletes the specified NodeTemplate resource.

Parameters

nodeTemplate (required)#

Name of the NodeTemplate resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_nodes_from_node_group#

Deletes specified nodes from the node group.

Parameters

nodeGroup (required)#

Name of the NodeGroup resource whose nodes will be deleted.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "nodes" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_autoscaler#

Deletes the specified autoscaler.

Parameters

autoscaler (required)#

Name of the autoscaler to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_backend_service#

Deletes the specified regional BackendService resource.

Parameters

backendService (required)#

Name of the BackendService resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_disk#

Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Parameters

disk (required)#

Name of the regional persistent disk to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_health_check#

Deletes the specified HealthCheck resource.

Parameters

healthCheck (required)#

Name of the HealthCheck resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_instance_group_manager#

Deletes the specified managed instance group and all of the instances in that group.

Parameters

instanceGroupManager (required)#

Name of the managed instance group to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_operation#

Deletes the specified region-specific Operations resource.

Parameters

operation (required)#

Name of the Operations resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_ssl_certificate#

Deletes the specified SslCertificate resource in the region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

sslCertificate (required)#

Name of the SslCertificate resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_target_http_proxy#

Deletes the specified TargetHttpProxy resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetHttpProxy (required)#

Name of the TargetHttpProxy resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_target_https_proxy#

Deletes the specified TargetHttpsProxy resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_region_url_map#

Deletes the specified UrlMap resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_reservation#

Deletes the specified reservation.

Parameters

project (required)#

Project ID for this request.

Type: string

reservation (required)#

Name of the reservation to delete.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_resource_policy#

Deletes the specified resource policy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

resourcePolicy (required)#

Name of the resource policy to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_route#

Deletes the specified Route resource.

Parameters

project (required)#

Project ID for this request.

Type: string

route (required)#

Name of the Route resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_router#

Deletes the specified Router resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

router (required)#

Name of the Router resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_security_policy#

Deletes the specified policy.

Parameters

project (required)#

Project ID for this request.

Type: string

securityPolicy (required)#

Name of the security policy to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_signed_url_key_to_backend_bucket#

Deletes a key for validating requests with signed URLs for this backend bucket.

Parameters

backendBucket (required)#

Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.

Type: string

keyName (required)#

The name of the Signed URL Key to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_signed_url_key_to_backend_service#

Deletes a key for validating requests with signed URLs for this backend service.

Parameters

backendService (required)#

Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.

Type: string

keyName (required)#

The name of the Signed URL Key to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_snapshot#

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snapshots.

Parameters

project (required)#

Project ID for this request.

Type: string

snapshot (required)#

Name of the Snapshot resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_ssl_certificate#

Deletes the specified SslCertificate resource.

Parameters

project (required)#

Project ID for this request.

Type: string

sslCertificate (required)#

Name of the SslCertificate resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_ssl_policy#

Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

Parameters

project (required)#

Project ID for this request.

Type: string

sslPolicy (required)#

Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_subnetwork#

Deletes the specified subnetwork.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

subnetwork (required)#

Name of the Subnetwork resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_target_http_proxy#

Deletes the specified TargetHttpProxy resource.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpProxy (required)#

Name of the TargetHttpProxy resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_target_https_proxy#

Deletes the specified TargetHttpsProxy resource.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_target_instance#

Deletes the specified TargetInstance resource.

Parameters

project (required)#

Project ID for this request.

Type: string

targetInstance (required)#

Name of the TargetInstance resource to delete.

Type: string

zone (required)#

Name of the zone scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_target_pool#

Deletes the specified target pool.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetPool (required)#

Name of the TargetPool resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_target_ssl_proxy#

Deletes the specified TargetSslProxy resource.

Parameters

project (required)#

Project ID for this request.

Type: string

targetSslProxy (required)#

Name of the TargetSslProxy resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_target_tcp_proxy#

Deletes the specified TargetTcpProxy resource.

Parameters

project (required)#

Project ID for this request.

Type: string

targetTcpProxy (required)#

Name of the TargetTcpProxy resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_target_vpn_gateway#

Deletes the specified target VPN gateway.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

targetVpnGateway (required)#

Name of the target VPN gateway to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_url_map#

Deletes the specified UrlMap resource.

Parameters

project (required)#

Project ID for this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_vpn_gateway#

Deletes the specified VPN gateway.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

vpnGateway (required)#

Name of the VPN gateway to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_vpn_tunnel#

Deletes the specified VpnTunnel resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

vpnTunnel (required)#

Name of the VpnTunnel resource to delete.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

delete_zone_operation#

Deletes the specified zone-specific Operations resource.

Parameters

operation (required)#

Name of the Operations resource to delete.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

deprecate_image#

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

Parameters

image (required)#

Image name.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Deprecation status for a public resource.

Type: object

{
  "deleted" : "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" : "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" : "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.",
  "state" : "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.",
  "replacement" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

detach_disk_from_instance#

Detaches a disk from an instance.

Parameters

deviceName (required)#

The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.

Type: string

instance (required)#

Instance name for this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

detach_network_endpoints_to_network_endpoint_group#

Detach a list of network endpoints from the specified network endpoint group.

Parameters

networkEndpointGroup (required)#

The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the network endpoint group is located. It should comply with RFC1035.

Type: string

$body#

Type: object

{
  "networkEndpoints" : [ {
    "instance" : "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.\n\nThe name must be 1-63 characters long, and comply with RFC1035.",
    "port" : "Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.",
    "ipAddress" : "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."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

disable_xpn_host_for_project#

Disable this project as a shared VPC host project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

disable_xpn_resource_for_project#

Disable a service resource (also known as service project) associated with this host project.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "xpnResource" : {
    "id" : "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" : "The type of the service resource."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

enable_xpn_host_for_project#

Enable this project as a shared VPC host project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

enable_xpn_resource_for_project#

Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "xpnResource" : {
    "id" : "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" : "The type of the service resource."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

expand_ip_cidr_range_for_subnetwork#

Expands the IP CIDR range of the subnetwork to a specified value.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

subnetwork (required)#

Name of the Subnetwork resource to update.

Type: string

$body#

Type: object

{
  "ipCidrRange" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_accelerator_type#

Returns the specified accelerator type.

Parameters

acceleratorType (required)#

Name of the accelerator type to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_address#

Returns the specified address resource.

Parameters

address (required)#

Name of the address resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_autoscaler#

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.

Parameters

autoscaler (required)#

Name of the autoscaler to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_backend_bucket#

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Parameters

backendBucket (required)#

Name of the BackendBucket resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_backend_service#

Returns the specified BackendService resource. Gets a list of available backend services.

Parameters

backendService (required)#

Name of the BackendService resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_diagnostics_for_interconnect#

Returns the interconnectDiagnostics for the specified interconnect.

Parameters

interconnect (required)#

Name of the interconnect resource to query.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_disk#

Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request.

Parameters

disk (required)#

Name of the persistent disk to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_disk_type#

Returns the specified disk type. Gets a list of available disk types by making a list() request.

Parameters

diskType (required)#

Name of the disk type to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_external_vpn_gateway#

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Parameters

externalVpnGateway (required)#

Name of the externalVpnGateway to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_firewall#

Returns the specified firewall.

Parameters

firewall (required)#

Name of the firewall rule to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_forwarding_rule#

Returns the specified ForwardingRule resource.

Parameters

forwardingRule (required)#

Name of the ForwardingRule resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_global_address#

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters

address (required)#

Name of the address resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_global_forwarding_rule#

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

Parameters

forwardingRule (required)#

Name of the ForwardingRule resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_global_operation#

Retrieves the specified Operations resource. Gets a list of operations by making a list() request.

Parameters

operation (required)#

Name of the Operations resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_guest_attributes_for_instance#

Returns the specified guest attributes entry.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

queryPath#

Specifies the guest attributes path to be queried.

Type: string

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

variableKey#

Specifies the key for the guest attributes entry.

Type: string

get_health_check#

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Parameters

healthCheck (required)#

Name of the HealthCheck resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_health_for_region_backend_service#

Gets the most recent health check results for this regional BackendService.

Parameters

backendService (required)#

Name of the BackendService resource for which to get health.

Type: string

project (required)#

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "group" : "A URI referencing one of the instance groups or network endpoint groups listed in the backend service."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_health_of_backend_service#

Gets the most recent health check results for this BackendService.

Parameters

backendService (required)#

Name of the BackendService resource to which the queried instance belongs.

Type: string

project (required)#

Type: string

$body#

Type: object

{
  "group" : "A URI referencing one of the instance groups or network endpoint groups listed in the backend service."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_health_of_target_pool#

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetPool (required)#

Name of the TargetPool resource to which the queried instance belongs.

Type: string

$body#

Type: object

{
  "instance" : "The URL for a specific instance."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_http_health_check#

Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.

Parameters

httpHealthCheck (required)#

Name of the HttpHealthCheck resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_https_health_check#

Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.

Parameters

httpsHealthCheck (required)#

Name of the HttpsHealthCheck resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_disk#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_image#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_instance#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_instance_template#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_license#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_node_group#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_node_template#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_reservation#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_resource_policy#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_snapshot#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_iam_policy_for_subnetwork#

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_image#

Returns the specified image. Gets a list of available images by making a list() request.

Parameters

image (required)#

Name of the image resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_image_from_family#

Returns the latest image that is part of an image family and is not deprecated.

Parameters

family (required)#

Name of the image family to search for.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_instance#

Returns the specified Instance resource. Gets a list of available instances by making a list() request.

Parameters

instance (required)#

Name of the instance resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_instance_group#

Returns the specified instance group. Gets a list of available instance groups by making a list() request.

Parameters

instanceGroup (required)#

The name of the instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the instance group is located.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_instance_group_manager#

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_instance_template#

Returns the specified instance template. Gets a list of available instance templates by making a list() request.

Parameters

instanceTemplate (required)#

The name of the instance template.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_interconnect#

Returns the specified interconnect. Get a list of available interconnects by making a list() request.

Parameters

interconnect (required)#

Name of the interconnect to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_interconnect_attachment#

Returns the specified interconnect attachment.

Parameters

interconnectAttachment (required)#

Name of the interconnect attachment to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_interconnect_location#

Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.

Parameters

interconnectLocation (required)#

Name of the interconnect location to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_license#

Returns the specified License resource.

Parameters

license (required)#

Name of the License resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_license_code#

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code.

Parameters

licenseCode (required)#

Number corresponding to the License code resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_machine_type#

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Parameters

machineType (required)#

Name of the machine type to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_nat_mapping_info_for_router#

Retrieves runtime Nat mapping information of VM endpoints.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

router (required)#

Name of the Router resource to query for Nat Mapping information of VM endpoints.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_network#

Returns the specified network. Gets a list of available networks by making a list() request.

Parameters

network (required)#

Name of the network to return.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_network_endpoint_group#

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Parameters

networkEndpointGroup (required)#

The name of the network endpoint group. It should comply with RFC1035.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the network endpoint group is located. It should comply with RFC1035.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_node_group#

Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead.

Parameters

nodeGroup (required)#

Name of the node group to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_node_template#

Returns the specified node template. Gets a list of available node templates by making a list() request.

Parameters

nodeTemplate (required)#

Name of the node template to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_node_type#

Returns the specified node type. Gets a list of available node types by making a list() request.

Parameters

nodeType (required)#

Name of the node type to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_project#

Returns the specified Project resource.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region#

Returns the specified Region resource. Gets a list of available regions by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_autoscaler#

Returns the specified autoscaler.

Parameters

autoscaler (required)#

Name of the autoscaler to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_backend_service#

Returns the specified regional BackendService resource.

Parameters

backendService (required)#

Name of the BackendService resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_commitment#

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

Parameters

commitment (required)#

Name of the commitment to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_disk#

Returns a specified regional persistent disk.

Parameters

disk (required)#

Name of the regional persistent disk to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_disk_type#

Returns the specified regional disk type. Gets a list of available disk types by making a list() request.

Parameters

diskType (required)#

Name of the disk type to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_health_check#

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Parameters

healthCheck (required)#

Name of the HealthCheck resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_instance_group#

Returns the specified instance group resource.

Parameters

instanceGroup (required)#

Name of the instance group resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_instance_group_manager#

Returns all of the details about the specified managed instance group.

Parameters

instanceGroupManager (required)#

Name of the managed instance group to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_operation#

Retrieves the specified region-specific Operations resource.

Parameters

operation (required)#

Name of the Operations resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_ssl_certificate#

Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

sslCertificate (required)#

Name of the SslCertificate resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_target_http_proxy#

Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetHttpProxy (required)#

Name of the TargetHttpProxy resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_target_https_proxy#

Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_region_url_map#

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_reservation#

Retrieves information about the specified reservation.

Parameters

project (required)#

Project ID for this request.

Type: string

reservation (required)#

Name of the reservation to retrieve.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_resource_policy#

Retrieves all information of the specified resource policy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

resourcePolicy (required)#

Name of the resource policy to retrieve.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_route#

Returns the specified Route resource. Gets a list of available routes by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

route (required)#

Name of the Route resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_router#

Returns the specified Router resource. Gets a list of available routers by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

router (required)#

Name of the Router resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_router_status_for_router#

Retrieves runtime information of the specified router.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

router (required)#

Name of the Router resource to query.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_rule_for_security_policy#

Gets a rule at the specified priority.

Parameters

project (required)#

Project ID for this request.

Type: string

securityPolicy (required)#

Name of the security policy to which the queried rule belongs.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

priority#

The priority of the rule to get from the security policy.

Type: integer

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_security_policy#

List all of the ordered rules present in a single specified policy.

Parameters

project (required)#

Project ID for this request.

Type: string

securityPolicy (required)#

Name of the security policy to get.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_serial_port_output_from_instance#

Returns the last 1 MB of serial port output from the specified instance.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

port#

Specifies which COM or serial port to retrieve data from.

Type: integer

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

start#

Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_shielded_instance_identity_of_instance#

Returns the Shielded Instance Identity of an instance

Parameters

instance (required)#

Name or id of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_snapshot#

Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

snapshot (required)#

Name of the Snapshot resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_ssl_certificate#

Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

sslCertificate (required)#

Name of the SslCertificate resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_ssl_policy#

Lists all of the ordered rules present in a single specified policy.

Parameters

project (required)#

Project ID for this request.

Type: string

sslPolicy (required)#

Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_status_of_vpn_gateway#

Returns the status for the specified VPN gateway.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

vpnGateway (required)#

Name of the VPN gateway to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_subnetwork#

Returns the specified subnetwork. Gets a list of available subnetworks list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

subnetwork (required)#

Name of the Subnetwork resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_target_http_proxy#

Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpProxy (required)#

Name of the TargetHttpProxy resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_target_https_proxy#

Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_target_instance#

Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

targetInstance (required)#

Name of the TargetInstance resource to return.

Type: string

zone (required)#

Name of the zone scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_target_pool#

Returns the specified target pool. Gets a list of available target pools by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetPool (required)#

Name of the TargetPool resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_target_ssl_proxy#

Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

targetSslProxy (required)#

Name of the TargetSslProxy resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_target_tcp_proxy#

Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

targetTcpProxy (required)#

Name of the TargetTcpProxy resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_target_vpn_gateway#

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

targetVpnGateway (required)#

Name of the target VPN gateway to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_url_map#

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_vpn_gateway#

Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

vpnGateway (required)#

Name of the VPN gateway to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_vpn_tunnel#

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

vpnTunnel (required)#

Name of the VpnTunnel resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_xpn_host_for_project#

Gets the shared VPC host project that this project links to. May be empty if no link exists.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_xpn_resources_for_project#

Gets service resources (a.k.a service project) associated with this host project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

order_by#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_zone#

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone resource to return.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

get_zone_operation#

Retrieves the specified zone-specific Operations resource.

Parameters

operation (required)#

Name of the Operations resource to return.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_address#

Creates an address resource in the specified project by using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

Represents an IP Address resource.

An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.

A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)

Type: object

{
  "address" : "The static IP address represented by this resource.",
  "networkTier" : "This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.\n\nIf this field is not specified, it is assumed to be PREMIUM.",
  "purpose" : "The purpose of this resource, which can be one of the following values:  \n- `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. \n- `DNS_RESOLVER` for a DNS resolver address in a subnetwork \n- `VPC_PEERING` for addresses that are reserved for VPC peer networks. \n- `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.",
  "addressType" : "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.",
  "kind" : "[Output Only] Type of the resource. Always compute#address for addresses.",
  "description" : "An optional description of this resource. Provide this field when you create the resource.",
  "users" : [ "string" ],
  "network" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "prefixLength" : "The prefix length if the resource reprensents an IP range.",
  "ipVersion" : "The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.",
  "subnetwork" : "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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.",
  "status" : "[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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_autoscaler#

Creates an autoscaler in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

$body#

Represents an Autoscaler resource.

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. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Type: object

{
  "zone" : "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).",
  "kind" : "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "statusDetails" : [ {
    "message" : "The status message.",
    "type" : "The type of error returned."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
  "autoscalingPolicy" : {
    "cpuUtilization" : {
      "utilizationTarget" : "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales down 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.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization."
    },
    "loadBalancingUtilization" : {
      "utilizationTarget" : "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8."
    },
    "minNumReplicas" : "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.",
    "coolDownPeriodSec" : "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
    "customMetricUtilizations" : [ {
      "utilizationTargetType" : "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
      "metric" : "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.\n\nThe metric must have a value type of INT64 or DOUBLE.",
      "utilizationTarget" : "The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances."
    } ],
    "maxNumReplicas" : "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas."
  },
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "status" : "[Output Only] The status of the autoscaler configuration.",
  "target" : "URL of the managed instance group that this autoscaler will scale."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_backend_bucket#

Creates a BackendBucket resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

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.

Type: object

{
  "bucketName" : "Cloud Storage bucket name.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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" ]
  },
  "enableCdn" : "If true, enable Cloud CDN for this BackendBucket.",
  "kind" : "Type of the resource.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional textual description of the resource; provided by the client when the resource is created.",
  "id" : "[Output Only] Unique identifier for the resource; defined by the server.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_backend_service#

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Type: object

{
  "affinityCookieTtlSec" : "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 one day (86,400).",
  "healthChecks" : [ "string" ],
  "customRequestHeaders" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#backendService for backend services.",
  "sessionAffinity" : "Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.\n\nWhen the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "loadBalancingScheme" : "Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.",
  "portName" : "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nMust be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing).",
  "securityPolicy" : "[Output Only] The resource URL for the security policy associated with this backend service.",
  "backends" : [ {
    "maxConnectionsPerEndpoint" : "Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.",
    "maxConnectionsPerInstance" : "Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.",
    "capacityScaler" : "A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].\n\nThis cannot be used for internal load balancing.",
    "maxRatePerInstance" : "Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxRatePerEndpoint" : "Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.\n\nIf the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxUtilization" : "Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.\n\nThis parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "balancingMode" : "Specifies the balancing mode for the backend.\n\nWhen choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).\n\n \n- If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.\nYou can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.\n\nIf the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nIf the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.\n \n- If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).\nYou can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint.\n \n- If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group.\nYou can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.",
    "maxRate" : "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.\n\nThis cannot be used for internal load balancing.",
    "group" : "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.  \n\nYou 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" : "Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION."
  } ],
  "timeoutSec" : "The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "protocol" : "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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.",
    "cacheKeyPolicy" : {
      "includeHost" : "If true, requests to different hosts will be cached separately.",
      "includeProtocol" : "If true, http and https requests will be cached separately.",
      "queryStringWhitelist" : [ "string" ],
      "queryStringBlacklist" : [ "string" ],
      "includeQueryString" : "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."
    },
    "signedUrlKeyNames" : [ "string" ]
  },
  "enableCDN" : "If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.",
  "port" : "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.\n\nThis cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a BackendService.",
  "name" : "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.",
  "iap" : {
    "oauth2ClientSecretSha256" : "[Output Only] SHA256 hash value for the field oauth2_client_secret above.",
    "oauth2ClientId" : "string",
    "oauth2ClientSecret" : "string",
    "enabled" : "boolean"
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[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.",
  "connectionDraining" : {
    "drainingTimeoutSec" : "The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_disk#

Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Represents a Persistent Disk resource.

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. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==)

Type: object

{
  "sizeGb" : "Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.",
  "sourceSnapshotId" : "[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.",
  "lastDetachTimestamp" : "[Output Only] Last detach timestamp in RFC3339 text format.",
  "replicaZones" : [ "string" ],
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "guestOsFeatures" : [ {
    "type" : "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options."
  } ],
  "sourceSnapshot" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot \n- projects/project/global/snapshots/snapshot \n- global/snapshots/snapshot",
  "type" : "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-standard or pd-ssd",
  "labelFingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a disk.",
  "sourceImageEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "sourceSnapshotEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "zone" : "[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.",
  "diskEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "options" : "Internal use only.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "sourceImageId" : "[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.",
  "kind" : "[Output Only] Type of the resource. Always compute#disk for disks.",
  "resourcePolicies" : [ "string" ],
  "lastAttachTimestamp" : "[Output Only] Last attach timestamp in RFC3339 text format.",
  "users" : [ "string" ],
  "labels" : "Labels to apply to this disk. These can be later modified by the setLabels method.",
  "selfLink" : "[Output Only] Server-defined fully-qualified URL for this resource.",
  "licenses" : [ "string" ],
  "licenseCodes" : [ "int64" ],
  "physicalBlockSizeBytes" : "Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, 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.",
  "name" : "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.",
  "sourceImage" : "The source image used to create this disk. If the source image is deleted, this field will not be set.\n\nTo 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:\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the image name in the following format:\nglobal/images/my-custom-image\n\n\nYou 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:\nglobal/images/family/my-image-family",
  "region" : "[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.",
  "status" : "[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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

sourceImage#

Optional. Source image to restore onto a disk.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_external_vpn_gateway#

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

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 to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway.

Type: object

{
  "interfaces" : [ {
    "ipAddress" : "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.",
    "id" : "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"
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "labelFingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.",
  "redundancyType" : "Indicates the user-supplied redundancy type of this external VPN gateway.",
  "labels" : "Labels to apply to this ExternalVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_firewall#

Creates a firewall rule in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

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.

Type: object

{
  "sourceServiceAccounts" : [ "string" ],
  "logConfig" : {
    "enable" : "This field denotes whether to enable logging for a particular firewall rule."
  },
  "allowed" : [ {
    "IPProtocol" : "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" ]
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#firewall for firewall rules.",
  "description" : "An optional description of this resource. Provide this field when you create the resource.",
  "targetTags" : [ "string" ],
  "priority" : "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`.",
  "network" : "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:\nglobal/networks/default\nIf 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:  \n- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network \n- projects/myproject/global/networks/my-network \n- global/networks/default",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "targetServiceAccounts" : [ "string" ],
  "sourceRanges" : [ "string" ],
  "sourceTags" : [ "string" ],
  "destinationRanges" : [ "string" ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "disabled" : "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" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "denied" : [ {
    "IPProtocol" : "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" ]
  } ],
  "direction" : "Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_forwarding_rule#

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Forwarding Rule resource.

A forwardingRules resource represents a regional forwarding rule.

Regional external forwarding rules can reference any of the following resources:

  • A target instance
  • A Cloud VPN Classic gateway (targetVpnGateway),
  • A target pool for a Network Load Balancer
  • A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier
  • A target SSL proxy for a SSL Proxy load balancer using Standard Tier
  • A target TCP proxy for a TCP Proxy load balancer using Standard Tier.

Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer.

For regional internal forwarding rules, the following applies:

  • If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service.
  • If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy.

For more information, read Using Forwarding rules.

A globalForwardingRules resource represents a global forwarding rule.

Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==)

Type: object

{
  "portRange" : "This field is deprecated. See the port\nfield.",
  "networkTier" : "This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD.\n\nFor regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM.\n\nIf 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.",
  "kind" : "[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.",
  "IPProtocol" : "The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.\n\nWhen the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid.",
  "allPorts" : "This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields.\n\nWhen the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule.",
  "backendService" : "This field is only used for INTERNAL load balancing.\n\nFor internal load balancing, this field identifies the BackendService resource to receive the matched traffic.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "loadBalancingScheme" : "This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)",
  "ports" : [ "string" ],
  "serviceName" : "[Output Only] The internal fully qualified service name for this Forwarding Rule.\n\nThis field is only used for internal load balancing.",
  "network" : "This field is not used for external load balancing.\n\nFor INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "target" : "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live 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 INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid.",
  "ipVersion" : "The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule.",
  "subnetwork" : "This field is only used for INTERNAL load balancing.\n\nFor internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.\n\nIf the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "IPAddress" : "IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.\n\nIf you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:\n\n* IPv4 dotted decimal, as in `100.1.2.3` * Full 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 \n\nThe loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).",
  "region" : "[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.",
  "serviceLabel" : "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.\n\nThe 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.\n\nThis field is only used for internal load balancing."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_global_address#

Creates an address resource in the specified project by using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents an IP Address resource.

An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.

A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)

Type: object

{
  "address" : "The static IP address represented by this resource.",
  "networkTier" : "This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.\n\nIf this field is not specified, it is assumed to be PREMIUM.",
  "purpose" : "The purpose of this resource, which can be one of the following values:  \n- `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. \n- `DNS_RESOLVER` for a DNS resolver address in a subnetwork \n- `VPC_PEERING` for addresses that are reserved for VPC peer networks. \n- `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.",
  "addressType" : "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.",
  "kind" : "[Output Only] Type of the resource. Always compute#address for addresses.",
  "description" : "An optional description of this resource. Provide this field when you create the resource.",
  "users" : [ "string" ],
  "network" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "prefixLength" : "The prefix length if the resource reprensents an IP range.",
  "ipVersion" : "The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.",
  "subnetwork" : "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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.",
  "status" : "[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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_global_forwarding_rule#

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Forwarding Rule resource.

A forwardingRules resource represents a regional forwarding rule.

Regional external forwarding rules can reference any of the following resources:

  • A target instance
  • A Cloud VPN Classic gateway (targetVpnGateway),
  • A target pool for a Network Load Balancer
  • A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier
  • A target SSL proxy for a SSL Proxy load balancer using Standard Tier
  • A target TCP proxy for a TCP Proxy load balancer using Standard Tier.

Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer.

For regional internal forwarding rules, the following applies:

  • If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service.
  • If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy.

For more information, read Using Forwarding rules.

A globalForwardingRules resource represents a global forwarding rule.

Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==)

Type: object

{
  "portRange" : "This field is deprecated. See the port\nfield.",
  "networkTier" : "This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD.\n\nFor regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM.\n\nIf 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.",
  "kind" : "[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.",
  "IPProtocol" : "The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.\n\nWhen the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid.",
  "allPorts" : "This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields.\n\nWhen the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule.",
  "backendService" : "This field is only used for INTERNAL load balancing.\n\nFor internal load balancing, this field identifies the BackendService resource to receive the matched traffic.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "loadBalancingScheme" : "This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)",
  "ports" : [ "string" ],
  "serviceName" : "[Output Only] The internal fully qualified service name for this Forwarding Rule.\n\nThis field is only used for internal load balancing.",
  "network" : "This field is not used for external load balancing.\n\nFor INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "target" : "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live 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 INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid.",
  "ipVersion" : "The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule.",
  "subnetwork" : "This field is only used for INTERNAL load balancing.\n\nFor internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.\n\nIf the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "IPAddress" : "IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.\n\nIf you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:\n\n* IPv4 dotted decimal, as in `100.1.2.3` * Full 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 \n\nThe loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).",
  "region" : "[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.",
  "serviceLabel" : "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.\n\nThe 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.\n\nThis field is only used for internal load balancing."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_health_check#

Creates a HealthCheck resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "tcpHealthCheck" : {
    "request" : "The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, TCP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "type" : "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "httpsHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTPS health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTPS health check request. The default value is /."
  },
  "sslHealthCheck" : {
    "request" : "The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, SSL health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "http2HealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP2 health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP/2 health check request. The default value is /."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in 3339 text format.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "httpHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP health check request. The default value is /."
  },
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] Region where the health check resides. Not applicable to global health checks."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_http_health_check#

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a legacy HTTP Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "port" : "The TCP port number for the HTTP health check request. The default value is 80.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "host" : "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.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "requestPath" : "The request path of the HTTP health check request. The default value is /. This field does not support query parameters."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_https_health_check#

Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "port" : "The TCP port number for the HTTPS health check request. The default value is 443.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "host" : "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.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "requestPath" : "The request path of the HTTPS health check request. The default value is \"/\"."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_image#

Creates an image in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents an Image resource.

You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==)

Type: object

{
  "sourceSnapshotId" : "[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.",
  "deprecated" : {
    "deleted" : "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" : "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" : "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.",
    "state" : "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.",
    "replacement" : "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."
  },
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "guestOsFeatures" : [ {
    "type" : "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options."
  } ],
  "sourceSnapshot" : "URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of:  \n- this property, or  \n- the sourceImage property, or  \n- the rawDisk.source property, or  \n- the sourceDisk property   in order to create an image.",
  "labelFingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an image.",
  "sourceImageEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "sourceSnapshotEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "rawDisk" : {
    "sha1Checksum" : "[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.",
    "containerType" : "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.",
    "source" : "The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both."
  },
  "sourceDisk" : "URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk \n- projects/project/zones/zone/disks/disk \n- zones/zone/disks/disk",
  "sourceDiskId" : "[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.",
  "sourceImageId" : "[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.",
  "kind" : "[Output Only] Type of the resource. Always compute#image for images.",
  "imageEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "labels" : "Labels to apply to this image. These can be later modified by the setLabels method.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "licenses" : [ "string" ],
  "licenseCodes" : [ "int64" ],
  "sourceType" : "The type of the image used to create this disk. The default and only value is RAW",
  "name" : "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.",
  "sourceDiskEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "archiveSizeBytes" : "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).",
  "sourceImage" : "URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of:  \n- this property, or  \n- the rawDisk.source property, or  \n- the sourceDisk property   in order to create an image.",
  "family" : "The name of the image family to which this image belongs. You can create disks by specifying 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.",
  "diskSizeGb" : "Size of the image when restored onto a persistent disk (in GB).",
  "status" : "[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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

forceCreate#

Force image creation if true.

Type: boolean

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_instance#

Creates an instance resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Represents an Instance resource.

An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==)

Type: object

{
  "metadata" : {
    "kind" : "[Output Only] Type of the resource. Always compute#metadata for metadata.",
    "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve the resource.",
    "items" : [ {
      "value" : "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).",
      "key" : "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."
    } ]
  },
  "serviceAccounts" : [ {
    "scopes" : [ "string" ],
    "email" : "Email address of the service account."
  } ],
  "shieldedInstanceIntegrityPolicy" : {
    "updateAutoLearnPolicy" : "Updates the integrity policy baseline using the measurements from the VM instance's most recent boot."
  },
  "disks" : [ {
    "kind" : "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
    "index" : "[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.",
    "guestOsFeatures" : [ {
      "type" : "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options."
    } ],
    "source" : "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.\n\nIf desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.\n\nNote that for InstanceTemplate, specify the disk name, not the URL for the disk.",
    "interface" : "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported.",
    "type" : "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
    "deviceName" : "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.\n\nIf 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.",
    "initializeParams" : {
      "diskName" : "Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.",
      "sourceImageEncryptionKey" : {
        "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
        "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
        "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
      },
      "sourceSnapshotEncryptionKey" : {
        "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
        "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
        "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
      },
      "resourcePolicies" : [ "string" ],
      "description" : "An optional description. Provide this property when creating the disk.",
      "sourceSnapshot" : "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.\n\nTo create a disk with a snapshot that you created, specify the snapshot name in the following format:\nglobal/snapshots/my-backup\n\n\nIf the source snapshot is deleted later, this field will not be set.",
      "diskType" : "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:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard\n\n\nOther values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n- projects/project/zones/zone/diskTypes/diskType \n- zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.",
      "sourceImage" : "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.\n\nTo 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:\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the image name in the following format:\nglobal/images/my-custom-image\n\n\nYou 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:\nglobal/images/family/my-image-family\n\n\nIf the source image is deleted later, this field will not be set.",
      "diskSizeGb" : "Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB.",
      "labels" : "Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks."
    },
    "mode" : "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.",
    "licenses" : [ "string" ],
    "diskEncryptionKey" : {
      "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
      "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
      "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
    },
    "autoDelete" : "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
    "boot" : "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem."
  } ],
  "displayDevice" : {
    "enableDisplay" : "Defines whether the instance has Display enabled."
  },
  "reservationAffinity" : {
    "consumeReservationType" : "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.",
    "values" : [ "string" ],
    "key" : "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."
  },
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "cpuPlatform" : "[Output Only] The CPU platform used by this instance.",
  "labelFingerprint" : "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.\n\nTo see the latest fingerprint, make get() request to the instance.",
  "deletionProtection" : "Whether the resource should be protected against deletion.",
  "guestAccelerators" : [ {
    "acceleratorType" : "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.",
    "acceleratorCount" : "The number of the guest accelerator cards exposed to this instance."
  } ],
  "hostname" : "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.",
  "minCpuPlatform" : "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\".",
  "zone" : "[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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "scheduling" : {
    "automaticRestart" : "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.\n\nBy default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.",
    "preemptible" : "Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.",
    "onHostMaintenance" : "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.",
    "nodeAffinities" : [ {
      "values" : [ "string" ],
      "key" : "Corresponds to the label key of Node resource.",
      "operator" : "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity."
    } ]
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "machineType" : "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:\nzones/us-central1-f/machineTypes/n1-standard-1\n\n\nTo 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):\nzones/zone/machineTypes/custom-CPUS-MEMORY\n\n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120 \n\nFor a full list of restrictions, read the Specifications for custom machine types.",
  "canIpForward" : "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.",
  "shieldedInstanceConfig" : {
    "enableVtpm" : "Defines whether the instance has the vTPM enabled.",
    "enableIntegrityMonitoring" : "Defines whether the instance has integrity monitoring enabled.",
    "enableSecureBoot" : "Defines whether the instance has Secure Boot enabled."
  },
  "kind" : "[Output Only] Type of the resource. Always compute#instance for instances.",
  "startRestricted" : "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.",
  "statusMessage" : "[Output Only] An optional, human-readable explanation of the status.",
  "labels" : "Labels to apply to this instance. These can be later modified by the setLabels method.",
  "selfLink" : "[Output Only] Server-defined URL for this resource.",
  "tags" : {
    "fingerprint" : "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.\n\nTo see the latest fingerprint, make get() request to the instance.",
    "items" : [ "string" ]
  },
  "networkInterfaces" : [ {
    "aliasIpRanges" : [ {
      "ipCidrRange" : "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" : "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."
    } ],
    "kind" : "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.",
    "networkIP" : "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.",
    "subnetwork" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork \n- regions/region/subnetworks/subnetwork",
    "fingerprint" : "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, otherwise the request will fail with error 412 conditionNotMet.",
    "name" : "[Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.",
    "accessConfigs" : [ {
      "natIP" : "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" : "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.\n\nIf an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.\n\nIf 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.",
      "kind" : "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
      "name" : "The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.",
      "publicPtrDomainName" : "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.",
      "setPublicPtr" : "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.",
      "type" : "The type of configuration. The default and only option is ONE_TO_ONE_NAT."
    } ],
    "network" : "URL of the 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 network is not specified but the subnetwork is specified, the network is inferred.\n\nIf you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:  \n- https://www.googleapis.com/compute/v1/projects/project/global/networks/network \n- projects/project/global/networks/network \n- global/networks/default"
  } ],
  "name" : "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.",
  "status" : "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

sourceInstanceTemplate#

Specifies instance template to create the instance.

This field is optional. 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

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_instance_group#

Creates an instance group in the specified project using the parameters that are included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where you want to create the instance group.

Type: string

$body#

Represents an unmanaged Instance Group resource.

Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read Instance groups.

For zonal unmanaged Instance Group, use instanceGroups resource.

For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==)

Type: object

{
  "kind" : "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "namedPorts" : [ {
    "port" : "The port number, which can be a value between 1 and 65535.",
    "name" : "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
  } ],
  "network" : "The URL of the network to which all instances in the instance group belong.",
  "selfLink" : "[Output Only] The URL for this instance group. The server generates this URL.",
  "size" : "[Output Only] The total number of instances in the instance group.",
  "zone" : "[Output Only] The URL of the zone where the instance group is located (for zonal resources).",
  "subnetwork" : "[Output Only] The URL of the subnetwork to which all instances in the instance group belong.",
  "creationTimestamp" : "[Output Only] The creation timestamp for this instance group in RFC3339 text format.",
  "fingerprint" : "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.",
  "name" : "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.",
  "id" : "[Output Only] A unique identifier for this instance group, generated by the server.",
  "region" : "[Output Only] The URL of the region where the instance group is located (for regional resources)."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_instance_group_manager#

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where you want to create the managed instance group.

Type: string

$body#

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. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==)

Type: object

{
  "autoHealingPolicies" : [ {
    "initialDelaySec" : "The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].",
    "healthCheck" : "The URL for the health check that signals autohealing."
  } ],
  "instanceTemplate" : "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.",
  "kind" : "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
  "distributionPolicy" : {
    "zones" : [ {
      "zone" : "The URL of the zone. The zone must exist in the region where the managed instance group is located."
    } ]
  },
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "namedPorts" : [ {
    "port" : "The port number, which can be a value between 1 and 65535.",
    "name" : "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
  } ],
  "baseInstanceName" : "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.",
  "instanceGroup" : "[Output Only] The URL of the Instance Group resource.",
  "targetPools" : [ "string" ],
  "selfLink" : "[Output Only] The URL for this managed instance group. The server defines this URL.",
  "targetSize" : "The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.",
  "versions" : [ {
    "targetSize" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "instanceTemplate" : "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.",
    "name" : "Name of the version. Unique among all versions in the scope of this managed instance group."
  } ],
  "zone" : "[Output Only] The URL of the zone where the managed instance group is located (for zonal resources).",
  "updatePolicy" : {
    "maxSurge" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "minimalAction" : "Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.",
    "maxUnavailable" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "type" : "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls)."
  },
  "creationTimestamp" : "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.",
  "currentActions" : {
    "creatingWithoutRetries" : "[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.",
    "restarting" : "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
    "verifying" : "[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.",
    "deleting" : "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
    "refreshing" : "[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.",
    "abandoning" : "[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" : "[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.\n\nIf you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.",
    "recreating" : "[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.",
    "none" : "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions."
  },
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.",
  "name" : "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.",
  "id" : "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
  "region" : "[Output Only] The URL of the region where the managed instance group resides (for regional resources).",
  "status" : {
    "isStable" : "[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."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_instance_template#

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents an Instance Template resource.

You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==)

Type: object

{
  "sourceInstance" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance",
  "kind" : "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.",
  "creationTimestamp" : "[Output Only] The creation timestamp for this instance template in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] A unique identifier for this instance template. The server defines this identifier.",
  "sourceInstanceParams" : {
    "diskConfigs" : [ {
      "autoDelete" : "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
      "customImage" : "The custom source image to be used to restore this disk when instantiating this instance template.",
      "deviceName" : "Specifies the device name of the disk to which the configurations apply to.",
      "instantiateFrom" : "Specifies whether to include the disk and what image to use. Possible values are:  \n- 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. \n- 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. \n- custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. \n- attach-read-only: to attach a read-only disk. Applicable to read-only disks. \n- do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks."
    } ]
  },
  "properties" : {
    "canIpForward" : "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.",
    "metadata" : {
      "kind" : "[Output Only] Type of the resource. Always compute#metadata for metadata.",
      "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve the resource.",
      "items" : [ {
        "value" : "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).",
        "key" : "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."
      } ]
    },
    "serviceAccounts" : [ {
      "scopes" : [ "string" ],
      "email" : "Email address of the service account."
    } ],
    "disks" : [ {
      "kind" : "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
      "index" : "[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.",
      "guestOsFeatures" : [ {
        "type" : "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options."
      } ],
      "source" : "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.\n\nIf desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.\n\nNote that for InstanceTemplate, specify the disk name, not the URL for the disk.",
      "interface" : "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported.",
      "type" : "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
      "deviceName" : "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.\n\nIf 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.",
      "initializeParams" : {
        "diskName" : "Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.",
        "sourceImageEncryptionKey" : {
          "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
          "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
          "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
        },
        "sourceSnapshotEncryptionKey" : {
          "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
          "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
          "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
        },
        "resourcePolicies" : [ "string" ],
        "description" : "An optional description. Provide this property when creating the disk.",
        "sourceSnapshot" : "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.\n\nTo create a disk with a snapshot that you created, specify the snapshot name in the following format:\nglobal/snapshots/my-backup\n\n\nIf the source snapshot is deleted later, this field will not be set.",
        "diskType" : "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:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard\n\n\nOther values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n- projects/project/zones/zone/diskTypes/diskType \n- zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.",
        "sourceImage" : "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.\n\nTo 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:\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the image name in the following format:\nglobal/images/my-custom-image\n\n\nYou 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:\nglobal/images/family/my-image-family\n\n\nIf the source image is deleted later, this field will not be set.",
        "diskSizeGb" : "Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB.",
        "labels" : "Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks."
      },
      "mode" : "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.",
      "licenses" : [ "string" ],
      "diskEncryptionKey" : {
        "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
        "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
        "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
      },
      "autoDelete" : "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
      "boot" : "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem."
    } ],
    "shieldedInstanceConfig" : {
      "enableVtpm" : "Defines whether the instance has the vTPM enabled.",
      "enableIntegrityMonitoring" : "Defines whether the instance has integrity monitoring enabled.",
      "enableSecureBoot" : "Defines whether the instance has Secure Boot enabled."
    },
    "reservationAffinity" : {
      "consumeReservationType" : "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.",
      "values" : [ "string" ],
      "key" : "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."
    },
    "description" : "An optional text description for the instances that are created from this instance template.",
    "labels" : "Labels to apply to instances that are created from this template.",
    "tags" : {
      "fingerprint" : "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.\n\nTo see the latest fingerprint, make get() request to the instance.",
      "items" : [ "string" ]
    },
    "guestAccelerators" : [ {
      "acceleratorType" : "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.",
      "acceleratorCount" : "The number of the guest accelerator cards exposed to this instance."
    } ],
    "networkInterfaces" : [ {
      "aliasIpRanges" : [ {
        "ipCidrRange" : "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" : "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."
      } ],
      "kind" : "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.",
      "networkIP" : "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.",
      "subnetwork" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork \n- regions/region/subnetworks/subnetwork",
      "fingerprint" : "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, otherwise the request will fail with error 412 conditionNotMet.",
      "name" : "[Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.",
      "accessConfigs" : [ {
        "natIP" : "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" : "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.\n\nIf an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.\n\nIf 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.",
        "kind" : "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
        "name" : "The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.",
        "publicPtrDomainName" : "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.",
        "setPublicPtr" : "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.",
        "type" : "The type of configuration. The default and only option is ONE_TO_ONE_NAT."
      } ],
      "network" : "URL of the 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 network is not specified but the subnetwork is specified, the network is inferred.\n\nIf you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:  \n- https://www.googleapis.com/compute/v1/projects/project/global/networks/network \n- projects/project/global/networks/network \n- global/networks/default"
    } ],
    "minCpuPlatform" : "Minimum cpu/platform to be used by this instance. 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.",
    "scheduling" : {
      "automaticRestart" : "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.\n\nBy default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.",
      "preemptible" : "Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.",
      "onHostMaintenance" : "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.",
      "nodeAffinities" : [ {
        "values" : [ "string" ],
        "key" : "Corresponds to the label key of Node resource.",
        "operator" : "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity."
      } ]
    },
    "machineType" : "The machine type to use for instances that are created from this template."
  },
  "selfLink" : "[Output Only] The URL for this instance template. The server defines this URL."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_interconnect#

Creates a Interconnect in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents an Interconnect resource.

An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)

Type: object

{
  "operationalStatus" : "[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: \n- OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. \n- OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. \n- OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.",
  "interconnectType" : "Type of interconnect, which can take one of the following values: \n- PARTNER: A partner-managed interconnection shared between customers though a partner. \n- DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.",
  "peerIpAddress" : "[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.",
  "kind" : "[Output Only] Type of the resource. Always compute#interconnect for interconnects.",
  "interconnectAttachments" : [ "string" ],
  "requestedLinkCount" : "Target number of physical links in the link bundle, as requested by the customer.",
  "googleReferenceId" : "[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "expectedOutages" : [ {
    "issueType" : "Form this outage is expected to take, which can take one of the following values: \n- OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. \n- 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.",
    "affectedCircuits" : [ "string" ],
    "name" : "Unique identifier for this outage notification.",
    "description" : "A description about the purpose of the outage.",
    "startTime" : "Scheduled start time for the outage (milliseconds since Unix epoch).",
    "endTime" : "Scheduled end time for the outage (milliseconds since Unix epoch).",
    "source" : "The party that generated this notification, which can take the following value: \n- GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.",
    "state" : "State of this notification, which can take one of the following values: \n- ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. \n- CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with \"NS_\" have been deprecated in favor of the unprefixed values."
  } ],
  "customerName" : "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "circuitInfos" : [ {
    "customerDemarcId" : "Customer-side demarc ID for this circuit.",
    "googleCircuitId" : "Google-assigned unique ID for this circuit. Assigned at circuit turn-up.",
    "googleDemarcId" : "Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA."
  } ],
  "adminEnabled" : "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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "linkType" : "Type of link requested, which can take one of the following values: \n- LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics \n- 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.",
  "location" : "URL of the InterconnectLocation object that represents where this connection is to be provisioned.",
  "provisionedLinkCount" : "[Output Only] Number of links actually provisioned in this interconnect.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "state" : "[Output Only] The current state of Interconnect functionality, which can take one of the following values: \n- ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. \n- UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. \n- UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.",
  "googleIpAddress" : "[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.",
  "nocContactEmail" : "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 Stackdriver logs alerting and Cloud Notifications."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_interconnect_attachment#

Creates an InterconnectAttachment in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

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. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)

Type: object

{
  "cloudRouterIpAddress" : "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.",
  "operationalStatus" : "[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: \n- OS_ACTIVE: The attachment has been turned up and is ready to use. \n- OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.",
  "edgeAvailabilityDomain" : "Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: \n- AVAILABILITY_DOMAIN_ANY \n- AVAILABILITY_DOMAIN_1 \n- 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.",
  "vlanTag8021q" : "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.",
  "bandwidth" : "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: \n- BPS_50M: 50 Mbit/s \n- BPS_100M: 100 Mbit/s \n- BPS_200M: 200 Mbit/s \n- BPS_300M: 300 Mbit/s \n- BPS_400M: 400 Mbit/s \n- BPS_500M: 500 Mbit/s \n- BPS_1G: 1 Gbit/s \n- BPS_2G: 2 Gbit/s \n- BPS_5G: 5 Gbit/s \n- BPS_10G: 10 Gbit/s \n- BPS_20G: 20 Gbit/s \n- BPS_50G: 50 Gbit/s",
  "kind" : "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.",
  "googleReferenceId" : "[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.",
  "partnerMetadata" : {
    "partnerName" : "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.",
    "portalUrl" : "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.",
    "interconnectName" : "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."
  },
  "description" : "An optional description of this resource.",
  "pairingKey" : "[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\"",
  "type" : "The type of interconnect attachment this is, which can take one of the following values: \n- DEDICATED: an attachment to a Dedicated Interconnect. \n- PARTNER: an attachment to a Partner Interconnect, created by the customer. \n- PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.",
  "interconnect" : "URL of the underlying Interconnect object that this attachment's traffic will traverse through.",
  "customerRouterIpAddress" : "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "privateInterconnectInfo" : {
    "tag8021q" : "[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region."
  },
  "router" : "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 &amp; region within which the Cloud Router is configured.",
  "partnerAsn" : "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.",
  "adminEnabled" : "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.",
  "candidateSubnets" : [ "string" ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "state" : "[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: \n- ACTIVE: The attachment has been turned up and is ready to use. \n- UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. \n- PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. \n- PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. \n- PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. \n- 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.",
  "region" : "[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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_license#

Create a License resource in the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

A license resource.

Type: object

{
  "chargesUseFee" : "[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.",
  "resourceRequirements" : {
    "minGuestCpuCount" : "Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.",
    "minMemoryMb" : "Minimum memory required to use the Instance. Enforced at Instance creation and Instance start."
  },
  "kind" : "[Output Only] Type of resource. Always compute#license for licenses.",
  "transferable" : "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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "Name of the resource. The name must be 1-63 characters long and comply with RFC1035.",
  "description" : "An optional textual description of the resource; provided by the client when the resource is created.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "licenseCode" : "[Output Only] The unique code used to attach this license to images, snapshots, and disks.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_network#

Creates a network in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a VPC Network resource.

Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==)

Type: object

{
  "IPv4Range" : "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.",
  "kind" : "[Output Only] Type of the resource. Always compute#network for networks.",
  "autoCreateSubnetworks" : "When set to true, the VPC network is created in \"auto\" mode. When set to false, the VPC network is created in \"custom\" mode.\n\nAn 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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this field when you create the resource.",
  "peerings" : [ {
    "exchangeSubnetRoutes" : "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.",
    "autoCreateRoutes" : "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.",
    "name" : "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.",
    "state" : "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.",
    "exportCustomRoutes" : "Whether to export the custom routes to peer network.",
    "stateDetails" : "[Output Only] Details about the current state of the peering.",
    "importCustomRoutes" : "Whether to import the custom routes from peer network.",
    "network" : "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."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "subnetworks" : [ "string" ],
  "routingConfig" : {
    "routingMode" : "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."
  },
  "gatewayIPv4" : "[Output Only] The gateway address for default routing out of the network, selected by GCP.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_network_endpoint_group#

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.

Type: string

$body#

Represents a collection of network endpoints.

Type: object

{
  "defaultPort" : "The default port used if the port number is not specified in the network endpoint.",
  "networkEndpointType" : "Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT.",
  "size" : "[Output only] Number of network endpoints in the network endpoint group.",
  "zone" : "[Output Only] The URL of the zone where the network endpoint group is located.",
  "kind" : "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.",
  "subnetwork" : "Optional URL of the subnetwork to which all network endpoints in the NEG belong.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "network" : "The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_node_group#

Creates a NodeGroup resource in the specified project using the data included in the request.

Parameters

initialNodeCount (required)#

Initial count of nodes in the node group.

Type: integer

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Represent 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. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15

Type: object

{
  "size" : "[Output Only] The total number of nodes in the node group.",
  "zone" : "[Output Only] The name of the zone where the node group resides, such as us-central1-a.",
  "kind" : "[Output Only] The type of the resource. Always compute#nodeGroup for node group.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "nodeTemplate" : "The URL of the node template to which this node group belongs.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "status" : "string. Possible values: CREATING | DELETING | INVALID | READY"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_node_template#

Creates a NodeTemplate resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

$body#

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. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) (== NextID: 16 ==)

Type: object

{
  "nodeAffinityLabels" : "Labels to use for node affinity, which will be used in instance scheduling.",
  "kind" : "[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "nodeType" : "The node type to use for nodes group that are created from this template.",
  "serverBinding" : {
    "type" : "string. Possible values: RESTART_NODE_ON_ANY_SERVER | RESTART_NODE_ON_MINIMAL_SERVERS | SERVER_BINDING_TYPE_UNSPECIFIED"
  },
  "statusMessage" : "[Output Only] An optional, human-readable explanation of the status.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "nodeTypeFlexibility" : {
    "localSsd" : "string",
    "memory" : "string",
    "cpus" : "string"
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] The name of the region where the node template resides, such as us-central1.",
  "status" : "[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_autoscaler#

Creates an autoscaler in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents an Autoscaler resource.

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. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Type: object

{
  "zone" : "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).",
  "kind" : "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "statusDetails" : [ {
    "message" : "The status message.",
    "type" : "The type of error returned."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
  "autoscalingPolicy" : {
    "cpuUtilization" : {
      "utilizationTarget" : "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales down 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.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization."
    },
    "loadBalancingUtilization" : {
      "utilizationTarget" : "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8."
    },
    "minNumReplicas" : "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.",
    "coolDownPeriodSec" : "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
    "customMetricUtilizations" : [ {
      "utilizationTargetType" : "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
      "metric" : "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.\n\nThe metric must have a value type of INT64 or DOUBLE.",
      "utilizationTarget" : "The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances."
    } ],
    "maxNumReplicas" : "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas."
  },
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "status" : "[Output Only] The status of the autoscaler configuration.",
  "target" : "URL of the managed instance group that this autoscaler will scale."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_backend_service#

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Type: object

{
  "affinityCookieTtlSec" : "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 one day (86,400).",
  "healthChecks" : [ "string" ],
  "customRequestHeaders" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#backendService for backend services.",
  "sessionAffinity" : "Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.\n\nWhen the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "loadBalancingScheme" : "Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.",
  "portName" : "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nMust be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing).",
  "securityPolicy" : "[Output Only] The resource URL for the security policy associated with this backend service.",
  "backends" : [ {
    "maxConnectionsPerEndpoint" : "Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.",
    "maxConnectionsPerInstance" : "Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.",
    "capacityScaler" : "A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].\n\nThis cannot be used for internal load balancing.",
    "maxRatePerInstance" : "Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxRatePerEndpoint" : "Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.\n\nIf the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxUtilization" : "Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.\n\nThis parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "balancingMode" : "Specifies the balancing mode for the backend.\n\nWhen choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).\n\n \n- If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.\nYou can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.\n\nIf the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nIf the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.\n \n- If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).\nYou can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint.\n \n- If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group.\nYou can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.",
    "maxRate" : "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.\n\nThis cannot be used for internal load balancing.",
    "group" : "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.  \n\nYou 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" : "Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION."
  } ],
  "timeoutSec" : "The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "protocol" : "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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.",
    "cacheKeyPolicy" : {
      "includeHost" : "If true, requests to different hosts will be cached separately.",
      "includeProtocol" : "If true, http and https requests will be cached separately.",
      "queryStringWhitelist" : [ "string" ],
      "queryStringBlacklist" : [ "string" ],
      "includeQueryString" : "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."
    },
    "signedUrlKeyNames" : [ "string" ]
  },
  "enableCDN" : "If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.",
  "port" : "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.\n\nThis cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a BackendService.",
  "name" : "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.",
  "iap" : {
    "oauth2ClientSecretSha256" : "[Output Only] SHA256 hash value for the field oauth2_client_secret above.",
    "oauth2ClientId" : "string",
    "oauth2ClientSecret" : "string",
    "enabled" : "boolean"
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[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.",
  "connectionDraining" : {
    "drainingTimeoutSec" : "The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_commitment#

Creates a commitment in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

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. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)

Type: object

{
  "kind" : "[Output Only] Type of the resource. Always compute#commitment for commitments.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "resources" : [ {
    "acceleratorType" : "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.",
    "amount" : "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" : "Type of resource for which this commitment applies. Possible values are VCPU and MEMORY"
  } ],
  "statusMessage" : "[Output Only] An optional, human-readable explanation of the status.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "reservations" : [ {
    "zone" : "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.",
    "kind" : "[Output Only] Type of the resource. Always compute#reservations for reservations.",
    "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
    "name" : "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.",
    "commitment" : "[OutputOnly] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
    "specificReservation" : {
      "instanceProperties" : {
        "guestAccelerators" : [ {
          "acceleratorType" : "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.",
          "acceleratorCount" : "The number of the guest accelerator cards exposed to this instance."
        } ],
        "localSsds" : [ {
          "interface" : "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.",
          "diskSizeGb" : "Specifies the size of the disk in base-2 GB."
        } ],
        "minCpuPlatform" : "Minimum cpu platform the reservation.",
        "machineType" : "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."
      },
      "count" : "Specifies the number of resources that are allocated.",
      "inUseCount" : "[OutputOnly] Indicates how many instances are in use."
    },
    "specificReservationRequired" : "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.",
    "selfLink" : "[Output Only] Server-defined fully-qualified URL for this resource.",
    "status" : "[Output Only] The status of the reservation."
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where this commitment may be used.",
  "endTimestamp" : "[Output Only] Commitment end time in RFC3339 text format.",
  "plan" : "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).",
  "startTimestamp" : "[Output Only] Commitment start time in RFC3339 text format.",
  "status" : "[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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_disk#

Creates a persistent regional disk in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

Represents a Persistent Disk resource.

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. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==)

Type: object

{
  "sizeGb" : "Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.",
  "sourceSnapshotId" : "[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.",
  "lastDetachTimestamp" : "[Output Only] Last detach timestamp in RFC3339 text format.",
  "replicaZones" : [ "string" ],
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "guestOsFeatures" : [ {
    "type" : "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options."
  } ],
  "sourceSnapshot" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot \n- projects/project/global/snapshots/snapshot \n- global/snapshots/snapshot",
  "type" : "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-standard or pd-ssd",
  "labelFingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a disk.",
  "sourceImageEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "sourceSnapshotEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "zone" : "[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.",
  "diskEncryptionKey" : {
    "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
    "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
    "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "options" : "Internal use only.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "sourceImageId" : "[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.",
  "kind" : "[Output Only] Type of the resource. Always compute#disk for disks.",
  "resourcePolicies" : [ "string" ],
  "lastAttachTimestamp" : "[Output Only] Last attach timestamp in RFC3339 text format.",
  "users" : [ "string" ],
  "labels" : "Labels to apply to this disk. These can be later modified by the setLabels method.",
  "selfLink" : "[Output Only] Server-defined fully-qualified URL for this resource.",
  "licenses" : [ "string" ],
  "licenseCodes" : [ "int64" ],
  "physicalBlockSizeBytes" : "Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, 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.",
  "name" : "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.",
  "sourceImage" : "The source image used to create this disk. If the source image is deleted, this field will not be set.\n\nTo 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:\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the image name in the following format:\nglobal/images/my-custom-image\n\n\nYou 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:\nglobal/images/family/my-image-family",
  "region" : "[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.",
  "status" : "[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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

sourceImage#

Optional. Source image to restore onto a disk.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_health_check#

Creates a HealthCheck resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "tcpHealthCheck" : {
    "request" : "The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, TCP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "type" : "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "httpsHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTPS health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTPS health check request. The default value is /."
  },
  "sslHealthCheck" : {
    "request" : "The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, SSL health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "http2HealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP2 health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP/2 health check request. The default value is /."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in 3339 text format.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "httpHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP health check request. The default value is /."
  },
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] Region where the health check resides. Not applicable to global health checks."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_instance_group_manager#

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

A regional managed instance group can contain up to 2000 instances.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

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. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==)

Type: object

{
  "autoHealingPolicies" : [ {
    "initialDelaySec" : "The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].",
    "healthCheck" : "The URL for the health check that signals autohealing."
  } ],
  "instanceTemplate" : "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.",
  "kind" : "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
  "distributionPolicy" : {
    "zones" : [ {
      "zone" : "The URL of the zone. The zone must exist in the region where the managed instance group is located."
    } ]
  },
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "namedPorts" : [ {
    "port" : "The port number, which can be a value between 1 and 65535.",
    "name" : "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
  } ],
  "baseInstanceName" : "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.",
  "instanceGroup" : "[Output Only] The URL of the Instance Group resource.",
  "targetPools" : [ "string" ],
  "selfLink" : "[Output Only] The URL for this managed instance group. The server defines this URL.",
  "targetSize" : "The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.",
  "versions" : [ {
    "targetSize" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "instanceTemplate" : "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.",
    "name" : "Name of the version. Unique among all versions in the scope of this managed instance group."
  } ],
  "zone" : "[Output Only] The URL of the zone where the managed instance group is located (for zonal resources).",
  "updatePolicy" : {
    "maxSurge" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "minimalAction" : "Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.",
    "maxUnavailable" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "type" : "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls)."
  },
  "creationTimestamp" : "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.",
  "currentActions" : {
    "creatingWithoutRetries" : "[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.",
    "restarting" : "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
    "verifying" : "[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.",
    "deleting" : "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
    "refreshing" : "[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.",
    "abandoning" : "[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" : "[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.\n\nIf you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.",
    "recreating" : "[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.",
    "none" : "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions."
  },
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.",
  "name" : "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.",
  "id" : "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
  "region" : "[Output Only] The URL of the region where the managed instance group resides (for regional resources).",
  "status" : {
    "isStable" : "[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."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_ssl_certificate#

Creates a SslCertificate resource in the specified project and region using the data included in the request

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents an SSL Certificate resource.

This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==)

Type: object

{
  "privateKey" : "A write-only private key in PEM format. Only insert requests will include this field.",
  "kind" : "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.",
  "certificate" : "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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.",
  "selfLink" : "[Output only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_target_http_proxy#

Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Target HTTP Proxy resource.

A target HTTP proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)

Type: object

{
  "urlMap" : "URL to the UrlMap resource that defines the mapping from URL to the BackendService.",
  "kind" : "[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_target_https_proxy#

Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Target HTTPS Proxy resource.

A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)

Type: object

{
  "urlMap" : "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:  \n- https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map \n- projects/project/global/urlMaps/url-map \n- global/urlMaps/url-map",
  "sslCertificates" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.",
  "sslPolicy" : "URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.",
  "quicOverride" : "Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_region_url_map#

Creates a UrlMap resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

Type: object

{
  "tests" : [ {
    "path" : "Path portion of the URL.",
    "service" : "Expected BackendService resource the given URL should be mapped to.",
    "host" : "Host portion of the URL.",
    "description" : "Description of this test case."
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
  "hostRules" : [ {
    "hosts" : [ "string" ],
    "pathMatcher" : "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
    "description" : "An optional description of this resource. Provide this property when you create the resource."
  } ],
  "pathMatchers" : [ {
    "pathRules" : [ {
      "paths" : [ "string" ],
      "service" : "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any  weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
    } ],
    "name" : "The name to which this PathMatcher is referred by the HostRule.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "defaultService" : "The full or partial URL to the BackendService resource. This will be 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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService  If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service:  \n- compute.backendBuckets.use \n- compute.backendServices.use"
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "defaultService" : "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.",
  "region" : "[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" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_reservation#

Creates a new reservation. For more information, read Reserving zonal resources.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

$body#

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. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==)

Type: object

{
  "zone" : "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.",
  "kind" : "[Output Only] Type of the resource. Always compute#reservations for reservations.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "commitment" : "[OutputOnly] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "specificReservation" : {
    "instanceProperties" : {
      "guestAccelerators" : [ {
        "acceleratorType" : "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.",
        "acceleratorCount" : "The number of the guest accelerator cards exposed to this instance."
      } ],
      "localSsds" : [ {
        "interface" : "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.",
        "diskSizeGb" : "Specifies the size of the disk in base-2 GB."
      } ],
      "minCpuPlatform" : "Minimum cpu platform the reservation.",
      "machineType" : "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."
    },
    "count" : "Specifies the number of resources that are allocated.",
    "inUseCount" : "[OutputOnly] Indicates how many instances are in use."
  },
  "specificReservationRequired" : "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.",
  "selfLink" : "[Output Only] Server-defined fully-qualified URL for this resource.",
  "status" : "[Output Only] The status of the reservation."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_resource_policy#

Creates a new resource policy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

Type: object

{
  "kind" : "[Output Only] Type of the resource. Always compute#resource_policies for resource policies.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "string",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "snapshotSchedulePolicy" : {
    "schedule" : {
      "dailySchedule" : {
        "duration" : "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.",
        "daysInCycle" : "Defines a schedule that runs every nth day of the month.",
        "startTime" : "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."
      },
      "weeklySchedule" : {
        "dayOfWeeks" : [ {
          "duration" : "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.",
          "startTime" : "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.",
          "day" : "Allows to define schedule that runs specified day of the week."
        } ]
      },
      "hourlySchedule" : {
        "duration" : "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.",
        "hoursInCycle" : "Allows to define schedule that runs every nth hour.",
        "startTime" : "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT."
      }
    },
    "retentionPolicy" : {
      "onSourceDiskDelete" : "Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.",
      "maxRetentionDays" : "Maximum age of the snapshot that is allowed to be kept."
    },
    "snapshotProperties" : {
      "guestFlush" : "Indication to perform a ?guest aware? snapshot.",
      "storageLocations" : [ "string" ],
      "labels" : "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty."
    }
  },
  "region" : "string",
  "selfLink" : "[Output Only] Server-defined fully-qualified URL for this resource.",
  "status" : "[Output Only] The status of resource policy creation."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_route#

Creates a Route resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

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. (== resource_for beta.routes ==) (== resource_for v1.routes ==)

Type: object

{
  "nextHopGateway" : "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",
  "kind" : "[Output Only] Type of this resource. Always compute#routes for Route resources.",
  "nextHopPeering" : "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.",
  "warnings" : [ {
    "code" : "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
    "data" : [ {
      "value" : "[Output Only] A warning data value corresponding to the key.",
      "key" : "[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)."
    } ],
    "message" : "[Output Only] A human-readable description of the warning code."
  } ],
  "description" : "An optional description of this resource. Provide this field when you create the resource.",
  "priority" : "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.",
  "nextHopNetwork" : "The URL of the local network if it should handle matching packets.",
  "network" : "Fully-qualified URL of the network that this route applies to.",
  "selfLink" : "[Output Only] Server-defined fully-qualified URL for this resource.",
  "tags" : [ "string" ],
  "nextHopInstance" : "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "destRange" : "The destination range of outgoing packets that this route applies to. Only IPv4 is supported.",
  "nextHopVpnTunnel" : "The URL to a VpnTunnel that should handle matching packets.",
  "nextHopIp" : "The network IP address of an instance that should handle matching packets. Only IPv4 is supported.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_router#

Creates a Router resource in the specified project and region using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

Represents a Cloud Router resource.

For more information about Cloud Router, read the the Cloud Router overview.

Type: object

{
  "nats" : [ {
    "udpIdleTimeoutSec" : "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.",
    "logConfig" : {
      "filter" : "Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT.",
      "enable" : "Indicates whether or not to export logs. This is false by default."
    },
    "sourceSubnetworkIpRangesToNat" : "Specify the Nat option, which can take one of the following values: \n- ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. \n- ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. \n- 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 or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.",
    "minPortsPerVm" : "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.",
    "tcpEstablishedIdleTimeoutSec" : "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.",
    "name" : "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.",
    "natIpAllocateOption" : "Specify the NatIpAllocateOption, which can take one of the following values: \n- 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. \n- 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.",
    "natIps" : [ "string" ],
    "tcpTransitoryIdleTimeoutSec" : "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.",
    "icmpIdleTimeoutSec" : "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.",
    "subnetworks" : [ {
      "sourceIpRangesToNat" : [ "string. Possible values: ALL_IP_RANGES | LIST_OF_SECONDARY_IP_RANGES | PRIMARY_IP_RANGE" ],
      "secondaryIpRangeNames" : [ "string" ],
      "name" : "URL for the subnetwork resource that will use NAT."
    } ]
  } ],
  "interfaces" : [ {
    "ipRange" : "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.",
    "name" : "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.",
    "linkedVpnTunnel" : "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 either a VPN tunnel or an Interconnect attachment.",
    "linkedInterconnectAttachment" : "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 either be a VPN tunnel or an Interconnect attachment.",
    "managementType" : "[Output Only] The resource that configures and manages this interface. \n- MANAGED_BY_USER is the default value and can be managed directly by users. \n- 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."
  } ],
  "kind" : "[Output Only] Type of resource. Always compute#router for routers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "bgp" : {
    "advertiseMode" : "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.",
    "advertisedGroups" : [ "string. Possible values: ALL_SUBNETS" ],
    "advertisedIpRanges" : [ {
      "description" : "User-specified description for the IP range.",
      "range" : "The IP range to advertise. The value must be a CIDR-formatted string."
    } ],
    "asn" : "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."
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "bgpPeers" : [ {
    "advertisedRoutePriority" : "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.",
    "peerIpAddress" : "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.",
    "advertiseMode" : "User-specified flag to indicate which mode to use for advertisement.",
    "advertisedGroups" : [ "string. Possible values: ALL_SUBNETS" ],
    "ipAddress" : "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.",
    "name" : "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.",
    "interfaceName" : "Name of the interface the BGP peer is associated with.",
    "advertisedIpRanges" : [ {
      "description" : "User-specified description for the IP range.",
      "range" : "The IP range to advertise. The value must be a CIDR-formatted string."
    } ],
    "peerAsn" : "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.",
    "managementType" : "[Output Only] The resource that configures and manages this BGP peer. \n- MANAGED_BY_USER is the default value and can be managed by you or other users \n- 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."
  } ],
  "region" : "[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.",
  "network" : "URI of the network to which this router belongs.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_security_policy#

Creates a new policy in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Cloud Armor Security Policy resource.

Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==)

Type: object

{
  "kind" : "[Output only] Type of the resource. Always compute#securityPolicyfor security policies",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make get() request to the security policy.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "rules" : [ {
    "preview" : "If set to true, the specified action is not enforced.",
    "kind" : "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules",
    "match" : {
      "versionedExpr" : "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.",
      "config" : {
        "srcIpRanges" : [ "string" ]
      }
    },
    "action" : "The Action to preform when the client connection triggers the rule. Can currently be either \"allow\" or \"deny()\" where valid values for status are 403, 404, and 502.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "priority" : "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."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_ssl_certificate#

Creates a SslCertificate resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents an SSL Certificate resource.

This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==)

Type: object

{
  "privateKey" : "A write-only private key in PEM format. Only insert requests will include this field.",
  "kind" : "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.",
  "certificate" : "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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.",
  "selfLink" : "[Output only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_ssl_policy#

Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Cloud Armor Security Policy resource.

Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==)

Type: object

{
  "enabledFeatures" : [ "string" ],
  "kind" : "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.",
  "minTlsVersion" : "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.",
  "profile" : "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.",
  "warnings" : [ {
    "code" : "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
    "data" : [ {
      "value" : "[Output Only] A warning data value corresponding to the key.",
      "key" : "[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)."
    } ],
    "message" : "[Output Only] A human-readable description of the warning code."
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an SslPolicy.",
  "name" : "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.",
  "customFeatures" : [ "string" ],
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_subnetwork#

Creates a subnetwork in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

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. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)

Type: object

{
  "logConfig" : {
    "aggregationInterval" : "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.",
    "metadata" : "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 INCLUDE_ALL_METADATA.",
    "flowSampling" : "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, which means half of all collected logs are reported.",
    "enable" : "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 to disable flow logging."
  },
  "privateIpGoogleAccess" : "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.",
  "role" : "The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. 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.",
  "purpose" : "The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918.",
  "kind" : "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.",
  "description" : "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.",
  "network" : "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "enableFlowLogs" : "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 to disable flow logging.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a Subnetwork.",
  "name" : "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.",
  "gatewayAddress" : "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "state" : "[Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is 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.",
  "region" : "URL of the region where the Subnetwork resides. This field can be set only at resource creation time.",
  "secondaryIpRanges" : [ {
    "rangeName" : "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.",
    "ipCidrRange" : "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."
  } ],
  "ipCidrRange" : "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 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_target_http_proxy#

Creates a TargetHttpProxy resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Target HTTP Proxy resource.

A target HTTP proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)

Type: object

{
  "urlMap" : "URL to the UrlMap resource that defines the mapping from URL to the BackendService.",
  "kind" : "[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_target_https_proxy#

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Target HTTPS Proxy resource.

A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)

Type: object

{
  "urlMap" : "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:  \n- https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map \n- projects/project/global/urlMaps/url-map \n- global/urlMaps/url-map",
  "sslCertificates" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.",
  "sslPolicy" : "URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.",
  "quicOverride" : "Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_target_instance#

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone scoping this request.

Type: string

$body#

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. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==)

Type: object

{
  "instance" : "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: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance",
  "zone" : "[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.",
  "kind" : "[Output Only] The type of the resource. Always compute#targetInstance for target instances.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "natPolicy" : "NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_target_pool#

Creates a target pool in the specified project and region using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

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. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)

Type: object

{
  "healthChecks" : [ "string" ],
  "instances" : [ "string" ],
  "kind" : "[Output Only] Type of the resource. Always compute#targetPool for target pools.",
  "sessionAffinity" : "Session affinity option, must be one of the following values:\nNONE: Connections from the same client IP may go to any instance in the pool.\nCLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.\nCLIENT_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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "failoverRatio" : "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].\n\nIf 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.\n\nIn 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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the target pool resides.",
  "backupPool" : "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].\n\nbackupPool 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.\n\nIn 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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_target_ssl_proxy#

Creates a TargetSslProxy resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

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. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==)

Type: object

{
  "sslCertificates" : [ "string" ],
  "kind" : "[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.",
  "service" : "URL to the BackendService resource.",
  "sslPolicy" : "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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_target_tcp_proxy#

Creates a TargetTcpProxy resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

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 Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==)

Type: object

{
  "kind" : "[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.",
  "service" : "URL to the BackendService resource.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_target_vpn_gateway#

Creates a target VPN gateway in the specified project and region using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

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. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==)

Type: object

{
  "tunnels" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "forwardingRules" : [ "string" ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[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.",
  "network" : "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "status" : "[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_url_map#

Creates a UrlMap resource in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

Type: object

{
  "tests" : [ {
    "path" : "Path portion of the URL.",
    "service" : "Expected BackendService resource the given URL should be mapped to.",
    "host" : "Host portion of the URL.",
    "description" : "Description of this test case."
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
  "hostRules" : [ {
    "hosts" : [ "string" ],
    "pathMatcher" : "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
    "description" : "An optional description of this resource. Provide this property when you create the resource."
  } ],
  "pathMatchers" : [ {
    "pathRules" : [ {
      "paths" : [ "string" ],
      "service" : "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any  weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
    } ],
    "name" : "The name to which this PathMatcher is referred by the HostRule.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "defaultService" : "The full or partial URL to the BackendService resource. This will be 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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService  If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service:  \n- compute.backendBuckets.use \n- compute.backendServices.use"
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "defaultService" : "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.",
  "region" : "[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" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_vpn_gateway#

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

Represents a VPN gateway resource.

Type: object

{
  "vpnInterfaces" : [ {
    "ipAddress" : "The external IP address for this VPN gateway interface.",
    "id" : "The numeric ID of this VPN gateway interface."
  } ],
  "kind" : "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the VPN gateway resides.",
  "labelFingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an VpnGateway.",
  "labels" : "Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.",
  "network" : "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

insert_vpn_tunnel#

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

Represents a Cloud VPN Tunnel resource.

For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)

Type: object

{
  "peerGcpGateway" : "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.",
  "sharedSecretHash" : "Hash of the shared secret.",
  "kind" : "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
  "peerExternalGatewayInterface" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "ikeVersion" : "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.",
  "localTrafficSelector" : [ "string" ],
  "vpnGateway" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "peerExternalGateway" : "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.",
  "router" : "URL of the router resource to be used for dynamic routing.",
  "vpnGatewayInterface" : "The interface ID of the VPN gateway with which this VPN tunnel is associated.",
  "detailedStatus" : "[Output Only] Detailed status message for the VPN tunnel.",
  "peerIp" : "IP address of the peer VPN gateway. Only IPv4 is supported.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "remoteTrafficSelector" : [ "string" ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[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.",
  "sharedSecret" : "Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.",
  "targetVpnGateway" : "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.",
  "status" : "[Output Only] The status of the VPN tunnel, which can be one of the following: \n- PROVISIONING: Resource is being allocated for the VPN tunnel. \n- 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. \n- FIRST_HANDSHAKE: Successful first handshake with the peer VPN. \n- ESTABLISHED: Secure session is successfully established with the peer VPN. \n- NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS \n- AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). \n- NEGOTIATION_FAILURE: Handshake failed. \n- DEPROVISIONING: Resources are being deallocated for the VPN tunnel. \n- FAILED: Tunnel creation has failed and the tunnel is not ready to be used."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

invalidate_cache_for_url_map#

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Parameters

project (required)#

Project ID for this request.

Type: string

urlMap (required)#

Name of the UrlMap scoping this request.

Type: string

$body#

Type: object

{
  "path" : "string",
  "host" : "If set, this invalidation rule will only apply to requests with a Host header matching host."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_accelerator_types#

Retrieves a list of accelerator types available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_addresses#

Retrieves a list of addresses contained within the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_accelerator_types#

Retrieves an aggregated list of accelerator types.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_addresses#

Retrieves an aggregated list of addresses.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_autoscalers#

Retrieves an aggregated list of autoscalers.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_backend_services#

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Parameters

project (required)#

Name of the project scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_disk_types#

Retrieves an aggregated list of disk types.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_disks#

Retrieves an aggregated list of persistent disks.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_forwarding_rules#

Retrieves an aggregated list of forwarding rules.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_global_operations#

Retrieves an aggregated list of all operations.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_health_checks#

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

Parameters

project (required)#

Name of the project scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_instance_group_managers#

Retrieves the list of managed instance groups and groups them by zone.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_instance_groups#

Retrieves the list of instance groups and sorts them by zone.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_instances#

Retrieves aggregated list of all of the instances in your project across all regions and zones.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_interconnect_attachments#

Retrieves an aggregated list of interconnect attachments.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_machine_types#

Retrieves an aggregated list of machine types.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_network_endpoint_groups#

Retrieves the list of network endpoint groups and sorts them by zone.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_node_groups#

Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_node_templates#

Retrieves an aggregated list of node templates.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_node_types#

Retrieves an aggregated list of node types.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_region_commitments#

Retrieves an aggregated list of commitments.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_reservations#

Retrieves an aggregated list of reservations.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_resource_policies#

Retrieves an aggregated list of resource policies.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_routers#

Retrieves an aggregated list of routers.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_ssl_certificates#

Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.

Parameters

project (required)#

Name of the project scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_subnetworks#

Retrieves an aggregated list of subnetworks.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_target_http_proxies#

Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.

Parameters

project (required)#

Name of the project scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_target_https_proxies#

Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

Parameters

project (required)#

Name of the project scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_target_instances#

Retrieves an aggregated list of target instances.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_target_pools#

Retrieves an aggregated list of target pools.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_target_vpn_gateways#

Retrieves an aggregated list of target VPN gateways.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_url_maps#

Retrieves the list of all UrlMap resources, regional and global, available to the specified project.

Parameters

project (required)#

Name of the project scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_vpn_gateways#

Retrieves an aggregated list of VPN gateways.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_aggregated_vpn_tunnels#

Retrieves an aggregated list of VPN tunnels.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_autoscalers#

Retrieves a list of autoscalers contained within the specified zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_available_features_for_ssl_policy#

Lists all features that can be specified in the SSL policy when using custom profile.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_backend_buckets#

Retrieves the list of BackendBucket resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_backend_services#

Retrieves the list of BackendService resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_disk_types#

Retrieves a list of disk types available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_disks#

Retrieves a list of persistent disks contained within the specified zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_external_vpn_gateways#

Retrieves the list of ExternalVpnGateway available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_firewalls#

Retrieves the list of firewall rules available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_forwarding_rules#

Retrieves a list of ForwardingRule resources available to the specified project and region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_global_addresses#

Retrieves a list of global addresses.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_global_forwarding_rules#

Retrieves a list of GlobalForwardingRule resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_global_operations#

Retrieves a list of Operation resources contained within the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_health_checks#

Retrieves the list of HealthCheck resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_http_health_checks#

Retrieves the list of HttpHealthCheck resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_https_health_checks#

Retrieves the list of HttpsHealthCheck resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_images#

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_instance_group_managers#

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_instance_groups#

Retrieves the list of instance groups that are located in the specified project and zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the instance group is located.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_instance_templates#

Retrieves a list of instance templates that are contained within the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_instances#

Retrieves the list of instances contained within the specified zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_instances_in_instance_group#

Lists the instances in the specified instance group.

Parameters

instanceGroup (required)#

The name of the instance group from which you want to generate a list of included instances.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the instance group is located.

Type: string

$body#

Type: object

{
  "instanceState" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_instances_in_region_instance_group#

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

Parameters

instanceGroup (required)#

Name of the regional instance group for which we want to list the instances.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "instanceState" : "Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.",
  "portName" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_interconnect_attachments#

Retrieves the list of interconnect attachments contained within the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_interconnect_locations#

Retrieves the list of interconnect locations available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_interconnects#

Retrieves the list of interconnect available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_licenses#

Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_machine_types#

Retrieves a list of machine types available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_managed_instances_in_instance_group_manager#

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

order_by#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_managed_instances_region_instance_group_manag#

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

order_by#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_network_endpoint_groups#

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the network endpoint group is located. It should comply with RFC1035.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_network_endpoints_for_network_endpoint_group#

Lists the network endpoints in the specified network endpoint group.

Parameters

networkEndpointGroup (required)#

The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the network endpoint group is located. It should comply with RFC1035.

Type: string

$body#

Type: object

{
  "healthStatus" : "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, the health status of network endpoints will not be provided."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_networks#

Retrieves the list of networks available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_node_groups#

Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_node_templates#

Retrieves a list of node templates available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_node_types#

Retrieves a list of node types available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_nodes_in_node_group#

Lists nodes in the node group.

Parameters

nodeGroup (required)#

Name of the NodeGroup resource whose nodes you want to list.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_referrers_to_instances#

Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances.

Parameters

instance (required)#

Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_autoscalers#

Retrieves a list of autoscalers contained within the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_backend_services#

Retrieves the list of regional BackendService resources available to the specified project in the given region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_commitments#

Retrieves a list of commitments contained within the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_disk_types#

Retrieves a list of regional disk types available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_disks#

Retrieves the list of persistent disks contained within the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_health_checks#

Retrieves the list of HealthCheck resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_instance_group_managers#

Retrieves the list of managed instance groups that are contained within the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_instance_groups#

Retrieves the list of instance group resources contained within the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_operations#

Retrieves a list of Operation resources contained within the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_ssl_certificates#

Retrieves the list of SslCertificate resources available to the specified project in the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_target_http_proxies#

Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_target_https_proxies#

Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_region_url_maps#

Retrieves the list of UrlMap resources available to the specified project in the specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_regions#

Retrieves the list of region resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_reservations#

A list of all the reservations that have been configured for the specified project in specified zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_resource_policies#

A list all the resource policies that have been configured for the specified project in specified region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_routers#

Retrieves a list of Router resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_routes#

Retrieves the list of Route resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_security_policies#

List all the policies that have been configured for the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_snapshots#

Retrieves the list of Snapshot resources contained within the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_ssl_certificates#

Retrieves the list of SslCertificate resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_ssl_policies#

Lists all the SSL policies that have been configured for the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_subnetworks#

Retrieves a list of subnetworks available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_target_http_proxies#

Retrieves the list of TargetHttpProxy resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_target_https_proxies#

Retrieves the list of TargetHttpsProxy resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_target_instances#

Retrieves a list of TargetInstance resources available to the specified project and zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_target_pools#

Retrieves a list of target pools available to the specified project and region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_target_ssl_proxies#

Retrieves the list of TargetSslProxy resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_target_tcp_proxies#

Retrieves the list of TargetTcpProxy resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_target_vpn_gateways#

Retrieves a list of target VPN gateways available to the specified project and region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_url_maps#

Retrieves the list of UrlMap resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_usable_subnetworks#

Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_vpn_gateways#

Retrieves a list of VPN gateways available to the specified project and region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_vpn_tunnels#

Retrieves a list of VpnTunnel resources contained in the specified project and region.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_xpn_hosts_for_project#

Lists all shared VPC host projects visible to the user in an organization.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "organization" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

order_by#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_zone_operations#

Retrieves a list of Operation resources contained within the specified zone.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

list_zones#

Retrieves the list of Zone resources available to the specified project.

Parameters

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

orderBy#

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

move_disk_for_project#

Moves a persistent disk from one zone to another.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "targetDisk" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk \n- projects/project/zones/zone/disks/disk \n- zones/zone/disks/disk",
  "destinationZone" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

move_instance_for_project#

Moves an instance and its attached persistent disks from one zone to another.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "targetInstance" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance",
  "destinationZone" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_autoscaler#

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

$body#

Represents an Autoscaler resource.

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. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Type: object

{
  "zone" : "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).",
  "kind" : "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "statusDetails" : [ {
    "message" : "The status message.",
    "type" : "The type of error returned."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
  "autoscalingPolicy" : {
    "cpuUtilization" : {
      "utilizationTarget" : "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales down 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.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization."
    },
    "loadBalancingUtilization" : {
      "utilizationTarget" : "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8."
    },
    "minNumReplicas" : "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.",
    "coolDownPeriodSec" : "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
    "customMetricUtilizations" : [ {
      "utilizationTargetType" : "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
      "metric" : "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.\n\nThe metric must have a value type of INT64 or DOUBLE.",
      "utilizationTarget" : "The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances."
    } ],
    "maxNumReplicas" : "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas."
  },
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "status" : "[Output Only] The status of the autoscaler configuration.",
  "target" : "URL of the managed instance group that this autoscaler will scale."
}

alt#

Data format for the response.

Type: string

Potential values: json

autoscaler#

Name of the autoscaler to patch.

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_backend_bucket#

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

backendBucket (required)#

Name of the BackendBucket resource to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

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.

Type: object

{
  "bucketName" : "Cloud Storage bucket name.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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" ]
  },
  "enableCdn" : "If true, enable Cloud CDN for this BackendBucket.",
  "kind" : "Type of the resource.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional textual description of the resource; provided by the client when the resource is created.",
  "id" : "[Output Only] Unique identifier for the resource; defined by the server.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_backend_service#

Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

backendService (required)#

Name of the BackendService resource to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Type: object

{
  "affinityCookieTtlSec" : "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 one day (86,400).",
  "healthChecks" : [ "string" ],
  "customRequestHeaders" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#backendService for backend services.",
  "sessionAffinity" : "Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.\n\nWhen the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "loadBalancingScheme" : "Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.",
  "portName" : "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nMust be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing).",
  "securityPolicy" : "[Output Only] The resource URL for the security policy associated with this backend service.",
  "backends" : [ {
    "maxConnectionsPerEndpoint" : "Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.",
    "maxConnectionsPerInstance" : "Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.",
    "capacityScaler" : "A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].\n\nThis cannot be used for internal load balancing.",
    "maxRatePerInstance" : "Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxRatePerEndpoint" : "Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.\n\nIf the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxUtilization" : "Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.\n\nThis parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "balancingMode" : "Specifies the balancing mode for the backend.\n\nWhen choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).\n\n \n- If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.\nYou can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.\n\nIf the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nIf the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.\n \n- If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).\nYou can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint.\n \n- If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group.\nYou can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.",
    "maxRate" : "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.\n\nThis cannot be used for internal load balancing.",
    "group" : "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.  \n\nYou 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" : "Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION."
  } ],
  "timeoutSec" : "The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "protocol" : "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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.",
    "cacheKeyPolicy" : {
      "includeHost" : "If true, requests to different hosts will be cached separately.",
      "includeProtocol" : "If true, http and https requests will be cached separately.",
      "queryStringWhitelist" : [ "string" ],
      "queryStringBlacklist" : [ "string" ],
      "includeQueryString" : "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."
    },
    "signedUrlKeyNames" : [ "string" ]
  },
  "enableCDN" : "If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.",
  "port" : "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.\n\nThis cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a BackendService.",
  "name" : "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.",
  "iap" : {
    "oauth2ClientSecretSha256" : "[Output Only] SHA256 hash value for the field oauth2_client_secret above.",
    "oauth2ClientId" : "string",
    "oauth2ClientSecret" : "string",
    "enabled" : "boolean"
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[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.",
  "connectionDraining" : {
    "drainingTimeoutSec" : "The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_firewall#

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

firewall (required)#

Name of the firewall rule to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

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.

Type: object

{
  "sourceServiceAccounts" : [ "string" ],
  "logConfig" : {
    "enable" : "This field denotes whether to enable logging for a particular firewall rule."
  },
  "allowed" : [ {
    "IPProtocol" : "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" ]
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#firewall for firewall rules.",
  "description" : "An optional description of this resource. Provide this field when you create the resource.",
  "targetTags" : [ "string" ],
  "priority" : "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`.",
  "network" : "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:\nglobal/networks/default\nIf 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:  \n- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network \n- projects/myproject/global/networks/my-network \n- global/networks/default",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "targetServiceAccounts" : [ "string" ],
  "sourceRanges" : [ "string" ],
  "sourceTags" : [ "string" ],
  "destinationRanges" : [ "string" ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "disabled" : "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" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "denied" : [ {
    "IPProtocol" : "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" ]
  } ],
  "direction" : "Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_health_check#

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

healthCheck (required)#

Name of the HealthCheck resource to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "tcpHealthCheck" : {
    "request" : "The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, TCP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "type" : "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "httpsHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTPS health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTPS health check request. The default value is /."
  },
  "sslHealthCheck" : {
    "request" : "The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, SSL health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "http2HealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP2 health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP/2 health check request. The default value is /."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in 3339 text format.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "httpHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP health check request. The default value is /."
  },
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] Region where the health check resides. Not applicable to global health checks."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_http_health_check#

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

httpHealthCheck (required)#

Name of the HttpHealthCheck resource to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a legacy HTTP Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "port" : "The TCP port number for the HTTP health check request. The default value is 80.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "host" : "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.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "requestPath" : "The request path of the HTTP health check request. The default value is /. This field does not support query parameters."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_https_health_check#

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

httpsHealthCheck (required)#

Name of the HttpsHealthCheck resource to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "port" : "The TCP port number for the HTTPS health check request. The default value is 443.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "host" : "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.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "requestPath" : "The request path of the HTTPS health check request. The default value is \"/\"."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_instance_group_manager#

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

instanceGroupManager (required)#

The name of the instance group manager.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where you want to create the managed instance group.

Type: string

$body#

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. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==)

Type: object

{
  "autoHealingPolicies" : [ {
    "initialDelaySec" : "The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].",
    "healthCheck" : "The URL for the health check that signals autohealing."
  } ],
  "instanceTemplate" : "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.",
  "kind" : "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
  "distributionPolicy" : {
    "zones" : [ {
      "zone" : "The URL of the zone. The zone must exist in the region where the managed instance group is located."
    } ]
  },
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "namedPorts" : [ {
    "port" : "The port number, which can be a value between 1 and 65535.",
    "name" : "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
  } ],
  "baseInstanceName" : "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.",
  "instanceGroup" : "[Output Only] The URL of the Instance Group resource.",
  "targetPools" : [ "string" ],
  "selfLink" : "[Output Only] The URL for this managed instance group. The server defines this URL.",
  "targetSize" : "The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.",
  "versions" : [ {
    "targetSize" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "instanceTemplate" : "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.",
    "name" : "Name of the version. Unique among all versions in the scope of this managed instance group."
  } ],
  "zone" : "[Output Only] The URL of the zone where the managed instance group is located (for zonal resources).",
  "updatePolicy" : {
    "maxSurge" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "minimalAction" : "Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.",
    "maxUnavailable" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "type" : "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls)."
  },
  "creationTimestamp" : "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.",
  "currentActions" : {
    "creatingWithoutRetries" : "[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.",
    "restarting" : "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
    "verifying" : "[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.",
    "deleting" : "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
    "refreshing" : "[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.",
    "abandoning" : "[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" : "[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.\n\nIf you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.",
    "recreating" : "[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.",
    "none" : "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions."
  },
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.",
  "name" : "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.",
  "id" : "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
  "region" : "[Output Only] The URL of the region where the managed instance group resides (for regional resources).",
  "status" : {
    "isStable" : "[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."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_interconnect#

Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

interconnect (required)#

Name of the interconnect to update.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents an Interconnect resource.

An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)

Type: object

{
  "operationalStatus" : "[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: \n- OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. \n- OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. \n- OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.",
  "interconnectType" : "Type of interconnect, which can take one of the following values: \n- PARTNER: A partner-managed interconnection shared between customers though a partner. \n- DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.",
  "peerIpAddress" : "[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.",
  "kind" : "[Output Only] Type of the resource. Always compute#interconnect for interconnects.",
  "interconnectAttachments" : [ "string" ],
  "requestedLinkCount" : "Target number of physical links in the link bundle, as requested by the customer.",
  "googleReferenceId" : "[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "expectedOutages" : [ {
    "issueType" : "Form this outage is expected to take, which can take one of the following values: \n- OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. \n- 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.",
    "affectedCircuits" : [ "string" ],
    "name" : "Unique identifier for this outage notification.",
    "description" : "A description about the purpose of the outage.",
    "startTime" : "Scheduled start time for the outage (milliseconds since Unix epoch).",
    "endTime" : "Scheduled end time for the outage (milliseconds since Unix epoch).",
    "source" : "The party that generated this notification, which can take the following value: \n- GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.",
    "state" : "State of this notification, which can take one of the following values: \n- ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. \n- CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with \"NS_\" have been deprecated in favor of the unprefixed values."
  } ],
  "customerName" : "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "circuitInfos" : [ {
    "customerDemarcId" : "Customer-side demarc ID for this circuit.",
    "googleCircuitId" : "Google-assigned unique ID for this circuit. Assigned at circuit turn-up.",
    "googleDemarcId" : "Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA."
  } ],
  "adminEnabled" : "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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "linkType" : "Type of link requested, which can take one of the following values: \n- LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics \n- 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.",
  "location" : "URL of the InterconnectLocation object that represents where this connection is to be provisioned.",
  "provisionedLinkCount" : "[Output Only] Number of links actually provisioned in this interconnect.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "state" : "[Output Only] The current state of Interconnect functionality, which can take one of the following values: \n- ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. \n- UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. \n- UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.",
  "googleIpAddress" : "[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.",
  "nocContactEmail" : "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 Stackdriver logs alerting and Cloud Notifications."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_interconnect_attachment#

Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

interconnectAttachment (required)#

Name of the interconnect attachment to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

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. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)

Type: object

{
  "cloudRouterIpAddress" : "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.",
  "operationalStatus" : "[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: \n- OS_ACTIVE: The attachment has been turned up and is ready to use. \n- OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.",
  "edgeAvailabilityDomain" : "Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: \n- AVAILABILITY_DOMAIN_ANY \n- AVAILABILITY_DOMAIN_1 \n- 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.",
  "vlanTag8021q" : "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.",
  "bandwidth" : "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: \n- BPS_50M: 50 Mbit/s \n- BPS_100M: 100 Mbit/s \n- BPS_200M: 200 Mbit/s \n- BPS_300M: 300 Mbit/s \n- BPS_400M: 400 Mbit/s \n- BPS_500M: 500 Mbit/s \n- BPS_1G: 1 Gbit/s \n- BPS_2G: 2 Gbit/s \n- BPS_5G: 5 Gbit/s \n- BPS_10G: 10 Gbit/s \n- BPS_20G: 20 Gbit/s \n- BPS_50G: 50 Gbit/s",
  "kind" : "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.",
  "googleReferenceId" : "[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.",
  "partnerMetadata" : {
    "partnerName" : "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.",
    "portalUrl" : "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.",
    "interconnectName" : "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."
  },
  "description" : "An optional description of this resource.",
  "pairingKey" : "[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\"",
  "type" : "The type of interconnect attachment this is, which can take one of the following values: \n- DEDICATED: an attachment to a Dedicated Interconnect. \n- PARTNER: an attachment to a Partner Interconnect, created by the customer. \n- PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.",
  "interconnect" : "URL of the underlying Interconnect object that this attachment's traffic will traverse through.",
  "customerRouterIpAddress" : "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "privateInterconnectInfo" : {
    "tag8021q" : "[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region."
  },
  "router" : "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 &amp; region within which the Cloud Router is configured.",
  "partnerAsn" : "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.",
  "adminEnabled" : "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.",
  "candidateSubnets" : [ "string" ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "state" : "[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: \n- ACTIVE: The attachment has been turned up and is ready to use. \n- UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. \n- PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. \n- PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. \n- PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. \n- 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.",
  "region" : "[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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_network#

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

Parameters

network (required)#

Name of the network to update.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a VPC Network resource.

Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==)

Type: object

{
  "IPv4Range" : "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.",
  "kind" : "[Output Only] Type of the resource. Always compute#network for networks.",
  "autoCreateSubnetworks" : "When set to true, the VPC network is created in \"auto\" mode. When set to false, the VPC network is created in \"custom\" mode.\n\nAn 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.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this field when you create the resource.",
  "peerings" : [ {
    "exchangeSubnetRoutes" : "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.",
    "autoCreateRoutes" : "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.",
    "name" : "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.",
    "state" : "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.",
    "exportCustomRoutes" : "Whether to export the custom routes to peer network.",
    "stateDetails" : "[Output Only] Details about the current state of the peering.",
    "importCustomRoutes" : "Whether to import the custom routes from peer network.",
    "network" : "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."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "subnetworks" : [ "string" ],
  "routingConfig" : {
    "routingMode" : "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."
  },
  "gatewayIPv4" : "[Output Only] The gateway address for default routing out of the network, selected by GCP.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_region_autoscaler#

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents an Autoscaler resource.

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. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Type: object

{
  "zone" : "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).",
  "kind" : "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "statusDetails" : [ {
    "message" : "The status message.",
    "type" : "The type of error returned."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
  "autoscalingPolicy" : {
    "cpuUtilization" : {
      "utilizationTarget" : "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales down 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.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization."
    },
    "loadBalancingUtilization" : {
      "utilizationTarget" : "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8."
    },
    "minNumReplicas" : "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.",
    "coolDownPeriodSec" : "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
    "customMetricUtilizations" : [ {
      "utilizationTargetType" : "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
      "metric" : "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.\n\nThe metric must have a value type of INT64 or DOUBLE.",
      "utilizationTarget" : "The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances."
    } ],
    "maxNumReplicas" : "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas."
  },
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "status" : "[Output Only] The status of the autoscaler configuration.",
  "target" : "URL of the managed instance group that this autoscaler will scale."
}

alt#

Data format for the response.

Type: string

Potential values: json

autoscaler#

Name of the autoscaler to patch.

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_region_backend_service#

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

backendService (required)#

Name of the BackendService resource to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Type: object

{
  "affinityCookieTtlSec" : "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 one day (86,400).",
  "healthChecks" : [ "string" ],
  "customRequestHeaders" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#backendService for backend services.",
  "sessionAffinity" : "Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.\n\nWhen the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "loadBalancingScheme" : "Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.",
  "portName" : "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nMust be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing).",
  "securityPolicy" : "[Output Only] The resource URL for the security policy associated with this backend service.",
  "backends" : [ {
    "maxConnectionsPerEndpoint" : "Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.",
    "maxConnectionsPerInstance" : "Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.",
    "capacityScaler" : "A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].\n\nThis cannot be used for internal load balancing.",
    "maxRatePerInstance" : "Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxRatePerEndpoint" : "Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.\n\nIf the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxUtilization" : "Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.\n\nThis parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "balancingMode" : "Specifies the balancing mode for the backend.\n\nWhen choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).\n\n \n- If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.\nYou can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.\n\nIf the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nIf the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.\n \n- If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).\nYou can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint.\n \n- If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group.\nYou can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.",
    "maxRate" : "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.\n\nThis cannot be used for internal load balancing.",
    "group" : "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.  \n\nYou 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" : "Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION."
  } ],
  "timeoutSec" : "The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "protocol" : "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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.",
    "cacheKeyPolicy" : {
      "includeHost" : "If true, requests to different hosts will be cached separately.",
      "includeProtocol" : "If true, http and https requests will be cached separately.",
      "queryStringWhitelist" : [ "string" ],
      "queryStringBlacklist" : [ "string" ],
      "includeQueryString" : "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."
    },
    "signedUrlKeyNames" : [ "string" ]
  },
  "enableCDN" : "If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.",
  "port" : "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.\n\nThis cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a BackendService.",
  "name" : "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.",
  "iap" : {
    "oauth2ClientSecretSha256" : "[Output Only] SHA256 hash value for the field oauth2_client_secret above.",
    "oauth2ClientId" : "string",
    "oauth2ClientSecret" : "string",
    "enabled" : "boolean"
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[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.",
  "connectionDraining" : {
    "drainingTimeoutSec" : "The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_region_health_check#

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

healthCheck (required)#

Name of the HealthCheck resource to patch.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "tcpHealthCheck" : {
    "request" : "The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, TCP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "type" : "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "httpsHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTPS health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTPS health check request. The default value is /."
  },
  "sslHealthCheck" : {
    "request" : "The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, SSL health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "http2HealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP2 health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP/2 health check request. The default value is /."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in 3339 text format.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "httpHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP health check request. The default value is /."
  },
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] Region where the health check resides. Not applicable to global health checks."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_region_instance_group_manager#

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

instanceGroupManager (required)#

The name of the instance group manager.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

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. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==)

Type: object

{
  "autoHealingPolicies" : [ {
    "initialDelaySec" : "The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].",
    "healthCheck" : "The URL for the health check that signals autohealing."
  } ],
  "instanceTemplate" : "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.",
  "kind" : "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
  "distributionPolicy" : {
    "zones" : [ {
      "zone" : "The URL of the zone. The zone must exist in the region where the managed instance group is located."
    } ]
  },
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "namedPorts" : [ {
    "port" : "The port number, which can be a value between 1 and 65535.",
    "name" : "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
  } ],
  "baseInstanceName" : "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.",
  "instanceGroup" : "[Output Only] The URL of the Instance Group resource.",
  "targetPools" : [ "string" ],
  "selfLink" : "[Output Only] The URL for this managed instance group. The server defines this URL.",
  "targetSize" : "The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.",
  "versions" : [ {
    "targetSize" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "instanceTemplate" : "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.",
    "name" : "Name of the version. Unique among all versions in the scope of this managed instance group."
  } ],
  "zone" : "[Output Only] The URL of the zone where the managed instance group is located (for zonal resources).",
  "updatePolicy" : {
    "maxSurge" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "minimalAction" : "Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.",
    "maxUnavailable" : {
      "fixed" : "Specifies a fixed number of VM instances. This must be a positive integer.",
      "calculated" : "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- 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 up.",
      "percent" : "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
    },
    "type" : "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls)."
  },
  "creationTimestamp" : "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.",
  "currentActions" : {
    "creatingWithoutRetries" : "[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.",
    "restarting" : "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
    "verifying" : "[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.",
    "deleting" : "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
    "refreshing" : "[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.",
    "abandoning" : "[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" : "[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.\n\nIf you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.",
    "recreating" : "[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.",
    "none" : "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions."
  },
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.",
  "name" : "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.",
  "id" : "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
  "region" : "[Output Only] The URL of the region where the managed instance group resides (for regional resources).",
  "status" : {
    "isStable" : "[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."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_region_url_map#

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to patch.

Type: string

$body#

Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

Type: object

{
  "tests" : [ {
    "path" : "Path portion of the URL.",
    "service" : "Expected BackendService resource the given URL should be mapped to.",
    "host" : "Host portion of the URL.",
    "description" : "Description of this test case."
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
  "hostRules" : [ {
    "hosts" : [ "string" ],
    "pathMatcher" : "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
    "description" : "An optional description of this resource. Provide this property when you create the resource."
  } ],
  "pathMatchers" : [ {
    "pathRules" : [ {
      "paths" : [ "string" ],
      "service" : "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any  weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
    } ],
    "name" : "The name to which this PathMatcher is referred by the HostRule.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "defaultService" : "The full or partial URL to the BackendService resource. This will be 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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService  If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service:  \n- compute.backendBuckets.use \n- compute.backendServices.use"
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "defaultService" : "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.",
  "region" : "[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" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_router#

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

router (required)#

Name of the Router resource to patch.

Type: string

$body#

Represents a Cloud Router resource.

For more information about Cloud Router, read the the Cloud Router overview.

Type: object

{
  "nats" : [ {
    "udpIdleTimeoutSec" : "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.",
    "logConfig" : {
      "filter" : "Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT.",
      "enable" : "Indicates whether or not to export logs. This is false by default."
    },
    "sourceSubnetworkIpRangesToNat" : "Specify the Nat option, which can take one of the following values: \n- ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. \n- ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. \n- 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 or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.",
    "minPortsPerVm" : "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.",
    "tcpEstablishedIdleTimeoutSec" : "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.",
    "name" : "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.",
    "natIpAllocateOption" : "Specify the NatIpAllocateOption, which can take one of the following values: \n- 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. \n- 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.",
    "natIps" : [ "string" ],
    "tcpTransitoryIdleTimeoutSec" : "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.",
    "icmpIdleTimeoutSec" : "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.",
    "subnetworks" : [ {
      "sourceIpRangesToNat" : [ "string. Possible values: ALL_IP_RANGES | LIST_OF_SECONDARY_IP_RANGES | PRIMARY_IP_RANGE" ],
      "secondaryIpRangeNames" : [ "string" ],
      "name" : "URL for the subnetwork resource that will use NAT."
    } ]
  } ],
  "interfaces" : [ {
    "ipRange" : "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.",
    "name" : "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.",
    "linkedVpnTunnel" : "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 either a VPN tunnel or an Interconnect attachment.",
    "linkedInterconnectAttachment" : "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 either be a VPN tunnel or an Interconnect attachment.",
    "managementType" : "[Output Only] The resource that configures and manages this interface. \n- MANAGED_BY_USER is the default value and can be managed directly by users. \n- 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."
  } ],
  "kind" : "[Output Only] Type of resource. Always compute#router for routers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "bgp" : {
    "advertiseMode" : "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.",
    "advertisedGroups" : [ "string. Possible values: ALL_SUBNETS" ],
    "advertisedIpRanges" : [ {
      "description" : "User-specified description for the IP range.",
      "range" : "The IP range to advertise. The value must be a CIDR-formatted string."
    } ],
    "asn" : "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."
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "bgpPeers" : [ {
    "advertisedRoutePriority" : "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.",
    "peerIpAddress" : "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.",
    "advertiseMode" : "User-specified flag to indicate which mode to use for advertisement.",
    "advertisedGroups" : [ "string. Possible values: ALL_SUBNETS" ],
    "ipAddress" : "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.",
    "name" : "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.",
    "interfaceName" : "Name of the interface the BGP peer is associated with.",
    "advertisedIpRanges" : [ {
      "description" : "User-specified description for the IP range.",
      "range" : "The IP range to advertise. The value must be a CIDR-formatted string."
    } ],
    "peerAsn" : "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.",
    "managementType" : "[Output Only] The resource that configures and manages this BGP peer. \n- MANAGED_BY_USER is the default value and can be managed by you or other users \n- 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."
  } ],
  "region" : "[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.",
  "network" : "URI of the network to which this router belongs.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_rule_in_security_policy#

Patches a rule at the specified priority.

Parameters

project (required)#

Project ID for this request.

Type: string

securityPolicy (required)#

Name of the security policy to update.

Type: string

$body#

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

Type: object

{
  "preview" : "If set to true, the specified action is not enforced.",
  "kind" : "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules",
  "match" : {
    "versionedExpr" : "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.",
    "config" : {
      "srcIpRanges" : [ "string" ]
    }
  },
  "action" : "The Action to preform when the client connection triggers the rule. Can currently be either \"allow\" or \"deny()\" where valid values for status are 403, 404, and 502.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "priority" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

priority#

The priority of the rule to patch.

Type: integer

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_security_policy#

Patches the specified policy with the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

securityPolicy (required)#

Name of the security policy to update.

Type: string

$body#

Represents a Cloud Armor Security Policy resource.

Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==)

Type: object

{
  "kind" : "[Output only] Type of the resource. Always compute#securityPolicyfor security policies",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make get() request to the security policy.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "rules" : [ {
    "preview" : "If set to true, the specified action is not enforced.",
    "kind" : "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules",
    "match" : {
      "versionedExpr" : "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.",
      "config" : {
        "srcIpRanges" : [ "string" ]
      }
    },
    "action" : "The Action to preform when the client connection triggers the rule. Can currently be either \"allow\" or \"deny()\" where valid values for status are 403, 404, and 502.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "priority" : "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."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_ssl_policy#

Patches the specified SSL policy with the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

sslPolicy (required)#

Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.

Type: string

$body#

Represents a Cloud Armor Security Policy resource.

Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==)

Type: object

{
  "enabledFeatures" : [ "string" ],
  "kind" : "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.",
  "minTlsVersion" : "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.",
  "profile" : "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.",
  "warnings" : [ {
    "code" : "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
    "data" : [ {
      "value" : "[Output Only] A warning data value corresponding to the key.",
      "key" : "[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)."
    } ],
    "message" : "[Output Only] A human-readable description of the warning code."
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve an SslPolicy.",
  "name" : "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.",
  "customFeatures" : [ "string" ],
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_subnetwork#

Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

subnetwork (required)#

Name of the Subnetwork resource to patch.

Type: string

$body#

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. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)

Type: object

{
  "logConfig" : {
    "aggregationInterval" : "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.",
    "metadata" : "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 INCLUDE_ALL_METADATA.",
    "flowSampling" : "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, which means half of all collected logs are reported.",
    "enable" : "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 to disable flow logging."
  },
  "privateIpGoogleAccess" : "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.",
  "role" : "The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. 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.",
  "purpose" : "The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918.",
  "kind" : "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.",
  "description" : "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.",
  "network" : "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "enableFlowLogs" : "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 to disable flow logging.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a Subnetwork.",
  "name" : "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.",
  "gatewayAddress" : "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "state" : "[Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is 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.",
  "region" : "URL of the region where the Subnetwork resides. This field can be set only at resource creation time.",
  "secondaryIpRanges" : [ {
    "rangeName" : "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.",
    "ipCidrRange" : "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."
  } ],
  "ipCidrRange" : "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 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

patch_url_map#

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

project (required)#

Project ID for this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to patch.

Type: string

$body#

Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

Type: object

{
  "tests" : [ {
    "path" : "Path portion of the URL.",
    "service" : "Expected BackendService resource the given URL should be mapped to.",
    "host" : "Host portion of the URL.",
    "description" : "Description of this test case."
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
  "hostRules" : [ {
    "hosts" : [ "string" ],
    "pathMatcher" : "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
    "description" : "An optional description of this resource. Provide this property when you create the resource."
  } ],
  "pathMatchers" : [ {
    "pathRules" : [ {
      "paths" : [ "string" ],
      "service" : "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any  weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
    } ],
    "name" : "The name to which this PathMatcher is referred by the HostRule.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "defaultService" : "The full or partial URL to the BackendService resource. This will be 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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService  If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service:  \n- compute.backendBuckets.use \n- compute.backendServices.use"
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "defaultService" : "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.",
  "region" : "[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" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

preview_router#

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

router (required)#

Name of the Router resource to query.

Type: string

$body#

Represents a Cloud Router resource.

For more information about Cloud Router, read the the Cloud Router overview.

Type: object

{
  "nats" : [ {
    "udpIdleTimeoutSec" : "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.",
    "logConfig" : {
      "filter" : "Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT.",
      "enable" : "Indicates whether or not to export logs. This is false by default."
    },
    "sourceSubnetworkIpRangesToNat" : "Specify the Nat option, which can take one of the following values: \n- ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. \n- ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. \n- 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 or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.",
    "minPortsPerVm" : "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.",
    "tcpEstablishedIdleTimeoutSec" : "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.",
    "name" : "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.",
    "natIpAllocateOption" : "Specify the NatIpAllocateOption, which can take one of the following values: \n- 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. \n- 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.",
    "natIps" : [ "string" ],
    "tcpTransitoryIdleTimeoutSec" : "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.",
    "icmpIdleTimeoutSec" : "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.",
    "subnetworks" : [ {
      "sourceIpRangesToNat" : [ "string. Possible values: ALL_IP_RANGES | LIST_OF_SECONDARY_IP_RANGES | PRIMARY_IP_RANGE" ],
      "secondaryIpRangeNames" : [ "string" ],
      "name" : "URL for the subnetwork resource that will use NAT."
    } ]
  } ],
  "interfaces" : [ {
    "ipRange" : "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.",
    "name" : "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.",
    "linkedVpnTunnel" : "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 either a VPN tunnel or an Interconnect attachment.",
    "linkedInterconnectAttachment" : "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 either be a VPN tunnel or an Interconnect attachment.",
    "managementType" : "[Output Only] The resource that configures and manages this interface. \n- MANAGED_BY_USER is the default value and can be managed directly by users. \n- 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."
  } ],
  "kind" : "[Output Only] Type of resource. Always compute#router for routers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "bgp" : {
    "advertiseMode" : "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.",
    "advertisedGroups" : [ "string. Possible values: ALL_SUBNETS" ],
    "advertisedIpRanges" : [ {
      "description" : "User-specified description for the IP range.",
      "range" : "The IP range to advertise. The value must be a CIDR-formatted string."
    } ],
    "asn" : "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."
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "bgpPeers" : [ {
    "advertisedRoutePriority" : "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.",
    "peerIpAddress" : "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.",
    "advertiseMode" : "User-specified flag to indicate which mode to use for advertisement.",
    "advertisedGroups" : [ "string. Possible values: ALL_SUBNETS" ],
    "ipAddress" : "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.",
    "name" : "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.",
    "interfaceName" : "Name of the interface the BGP peer is associated with.",
    "advertisedIpRanges" : [ {
      "description" : "User-specified description for the IP range.",
      "range" : "The IP range to advertise. The value must be a CIDR-formatted string."
    } ],
    "peerAsn" : "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.",
    "managementType" : "[Output Only] The resource that configures and manages this BGP peer. \n- MANAGED_BY_USER is the default value and can be managed by you or other users \n- 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."
  } ],
  "region" : "[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.",
  "network" : "URI of the network to which this router belongs.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

recreate_instances_in_instance_group_manager#

Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

You can specify a maximum of 1000 instances with this method per request.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

$body#

Type: object

{
  "instances" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

recreate_instances_region_instance_group_manager#

Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

You can specify a maximum of 1000 instances with this method per request.

Parameters

instanceGroupManager (required)#

Name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "instances" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

remove_health_check_from_target_pool#

Removes health check URL from a target pool.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

targetPool (required)#

Name of the target pool to remove health checks from.

Type: string

$body#

Type: object

{
  "healthChecks" : [ {
    "healthCheck" : "string"
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

remove_instance_from_target_pool#

Removes instance URL from a target pool.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetPool (required)#

Name of the TargetPool resource to remove instances from.

Type: string

$body#

Type: object

{
  "instances" : [ {
    "instance" : "The URL for a specific instance."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

remove_instances_from_instance_group#

Removes one or more instances from the specified instance group, but does not delete those instances.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.

Parameters

instanceGroup (required)#

The name of the instance group where the specified instances will be removed.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the instance group is located.

Type: string

$body#

Type: object

{
  "instances" : [ {
    "instance" : "The URL for a specific instance."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

remove_peering_from_network#

Removes a peering from the specified network.

Parameters

network (required)#

Name of the network resource to remove peering from.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "name" : "Name of the peering, which should conform to RFC1035."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

remove_resource_policy_for_disk#

Removes resource policies from a disk.

Parameters

disk (required)#

The disk name for this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "resourcePolicies" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

remove_resource_policy_for_region_disk#

Removes resource policies from a regional disk.

Parameters

disk (required)#

The disk name for this request.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

$body#

Type: object

{
  "resourcePolicies" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

remove_rule_from_security_policy#

Deletes a rule at the specified priority.

Parameters

project (required)#

Project ID for this request.

Type: string

securityPolicy (required)#

Name of the security policy to update.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

priority#

The priority of the rule to remove from the security policy.

Type: integer

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

reset_instance#

Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

resize_disk#

Resizes the specified persistent disk. You can only increase the size of the disk.

Parameters

disk (required)#

The name of the persistent disk.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "sizeGb" : "The new size of the persistent disk, which is specified in GB."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

resize_instance_group_manager#

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including:

  • The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance.

This list is subject to change.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

size (required)#

The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.

Type: integer

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

resize_region_disk#

Resizes the specified regional persistent disk.

Parameters

disk (required)#

Name of the regional persistent disk.

Type: string

project (required)#

The project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

$body#

Type: object

{
  "sizeGb" : "The new size of the regional persistent disk, which is specified in GB."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

resize_region_instance_group_manager#

Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances.

The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

Parameters

instanceGroupManager (required)#

Name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

size (required)#

Number of instances that should exist in this instance group manager.

Type: integer

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

resize_reservation#

Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.

Parameters

project (required)#

Project ID for this request.

Type: string

reservation (required)#

Name of the reservation to update.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

$body#

Type: object

{
  "specificSkuCount" : "Number of allocated resources can be resized with minimum = 1 and maximum = 1000."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_backend_service_for_target_ssl_proxy#

Changes the BackendService for TargetSslProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetSslProxy (required)#

Name of the TargetSslProxy resource whose BackendService resource is to be set.

Type: string

$body#

Type: object

{
  "service" : "The URL of the new BackendService resource for the targetSslProxy."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_backend_service_for_target_tcp_proxy#

Changes the BackendService for TargetTcpProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetTcpProxy (required)#

Name of the TargetTcpProxy resource whose BackendService resource is to be set.

Type: string

$body#

Type: object

{
  "service" : "The URL of the new BackendService resource for the targetTcpProxy."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_backup_for_target_pool#

Changes a backup target pool's configurations.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetPool (required)#

Name of the TargetPool resource to set a backup pool for.

Type: string

$body#

Type: object

{
  "target" : "string"
}

alt#

Data format for the response.

Type: string

Potential values: json

failoverRatio#

New failoverRatio value for the target pool.

Type: number

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_common_instance_metadata_for_project#

Sets metadata common to all instances within the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

A metadata key/value entry.

Type: object

{
  "kind" : "[Output Only] Type of the resource. Always compute#metadata for metadata.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve the resource.",
  "items" : [ {
    "value" : "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).",
    "key" : "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."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_default_network_tier_for_project#

Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "networkTier" : "Default network tier to be set."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_deletion_protection_for_instance#

Sets deletion protection on the instance.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

deletionProtection#

Whether the resource should be protected against deletion.

Type: boolean

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_disk_auto_delete_for_instance#

Sets the auto-delete flag for a disk attached to an instance.

Parameters

autoDelete (required)#

Whether to auto-delete the disk when the instance is deleted.

Type: boolean

deviceName (required)#

The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.

Type: string

instance (required)#

The instance name for this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_disk#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_image#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_instance#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_instance_template#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_license#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_node_group#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_node_template#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_reservation#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_resource_policy#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_snapshot#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_iam_policy_for_subnetwork#

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "bindings" : [ {
    "condition" : {
      "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
      "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
      "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
      "title" : "An 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."
    },
    "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
    "members" : [ "string" ]
  } ],
  "etag" : "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
  "policy" : {
    "bindings" : [ {
      "condition" : {
        "expression" : "Textual representation of an expression in Common Expression Language syntax.\n\nThe application context of the containing message determines which well-known feature set of CEL is supported.",
        "description" : "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
        "location" : "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
        "title" : "An 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."
      },
      "role" : "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
      "members" : [ "string" ]
    } ],
    "iamOwned" : "boolean",
    "etag" : "`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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.",
    "rules" : [ {
      "permissions" : [ "string" ],
      "logConfigs" : [ {
        "dataAccess" : {
          "logMode" : "Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now."
        },
        "cloudAudit" : {
          "authorizationLoggingOptions" : {
            "permissionType" : "The type of the permission that was checked."
          },
          "logName" : "The log_name to populate in the Cloud Audit Record."
        },
        "counter" : {
          "field" : "The field value to attribute.",
          "metric" : "The metric to update."
        }
      } ],
      "action" : "Required",
      "description" : "Human-readable description of the rule.",
      "conditions" : [ {
        "op" : "An operator to apply the subject with.",
        "svc" : "Trusted attributes discharged by the service.",
        "iam" : "Trusted attributes supplied by the IAM system.",
        "values" : [ "string" ],
        "sys" : "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control."
      } ],
      "notIns" : [ "string" ],
      "ins" : [ "string" ]
    } ],
    "version" : "Deprecated.",
    "auditConfigs" : [ {
      "auditLogConfigs" : [ {
        "logType" : "The log type that this config enables.",
        "exemptedMembers" : [ "string" ],
        "ignoreChildExemptions" : "Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored."
      } ],
      "exemptedMembers" : [ "string" ],
      "service" : "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."
    } ]
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_instance_template_for_instance_group_manager#

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

$body#

Type: object

{
  "instanceTemplate" : "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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_instance_template_region_instance_group_manage#

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "instanceTemplate" : "URL of the InstanceTemplate resource from which all new instances will be created."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_labels_for_disk#

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "labelFingerprint" : "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" : "The labels to set for this resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_labels_for_external_vpn_gateway#

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "labelFingerprint" : "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" : "A list of labels to apply for this resource. Each label key &amp; value must 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 example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\")."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_labels_for_image#

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "labelFingerprint" : "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" : "A list of labels to apply for this resource. Each label key &amp; value must 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 example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\")."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_labels_for_instance#

Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "labelFingerprint" : "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" : "object"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_labels_for_region_disk#

Sets the labels on the target regional disk.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "labelFingerprint" : "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" : "The labels to set for this resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_labels_for_snapshot#

Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "labelFingerprint" : "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" : "A list of labels to apply for this resource. Each label key &amp; value must 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 example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\")."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_labels_for_vpn_gateway#

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "labelFingerprint" : "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" : "The labels to set for this resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_machine_resources_for_instance#

Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "guestAccelerators" : [ {
    "acceleratorType" : "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.",
    "acceleratorCount" : "The number of the guest accelerator cards exposed to this instance."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_machine_type_for_instance#

Changes the machine type for a stopped instance to the machine type specified in the request.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "machineType" : "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"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_metadata_for_instance#

Sets metadata for the specified instance to the data included in the request.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

A metadata key/value entry.

Type: object

{
  "kind" : "[Output Only] Type of the resource. Always compute#metadata for metadata.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve the resource.",
  "items" : [ {
    "value" : "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).",
    "key" : "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."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_min_cpu_platform_for_instance#

Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "minCpuPlatform" : "Minimum cpu/platform this instance should be started at."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_named_ports_for_instance_group#

Sets the named ports for the specified instance group.

Parameters

instanceGroup (required)#

The name of the instance group where the named ports are updated.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the instance group is located.

Type: string

$body#

Type: object

{
  "fingerprint" : "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" : [ {
    "port" : "The port number, which can be a value between 1 and 65535.",
    "name" : "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_named_ports_for_region_instance_group#

Sets the named ports for the specified regional instance group.

Parameters

instanceGroup (required)#

The name of the regional instance group where the named ports are updated.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "fingerprint" : "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" : [ {
    "port" : "The port number, which can be a value between 1 and 65535.",
    "name" : "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_node_template_for_node_group#

Updates the node template of the node group.

Parameters

nodeGroup (required)#

Name of the NodeGroup resource to update.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "nodeTemplate" : "Full or partial URL of the node template resource to be updated for this node group."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_private_ip_google_access_for_subnetwork#

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

subnetwork (required)#

Name of the Subnetwork resource.

Type: string

$body#

Type: object

{
  "privateIpGoogleAccess" : "boolean"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_proxy_header_for_target_ssl_proxy#

Changes the ProxyHeaderType for TargetSslProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetSslProxy (required)#

Name of the TargetSslProxy resource whose ProxyHeader is to be set.

Type: string

$body#

Type: object

{
  "proxyHeader" : "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_proxy_header_for_target_tcp_proxy#

Changes the ProxyHeaderType for TargetTcpProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetTcpProxy (required)#

Name of the TargetTcpProxy resource whose ProxyHeader is to be set.

Type: string

$body#

Type: object

{
  "proxyHeader" : "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_quic_override_for_target_https_proxy#

Sets the QUIC override policy for TargetHttpsProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.

Type: string

$body#

Type: object

{
  "quicOverride" : "QUIC policy for the TargetHttpsProxy resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_scheduling_for_instance#

Sets an instance's scheduling options.

Parameters

instance (required)#

Instance name for this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Sets the scheduling options for an Instance. NextID: 9

Type: object

{
  "automaticRestart" : "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.\n\nBy default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.",
  "preemptible" : "Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.",
  "onHostMaintenance" : "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.",
  "nodeAffinities" : [ {
    "values" : [ "string" ],
    "key" : "Corresponds to the label key of Node resource.",
    "operator" : "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_security_policy_for_backend_service#

Sets the security policy for the specified backend service.

Parameters

backendService (required)#

Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "securityPolicy" : "string"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_service_account_for_instance#

Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Parameters

instance (required)#

Name of the instance resource to start.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "scopes" : [ "string" ],
  "email" : "Email address of the service account."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_shielded_instance_integrity_policy_of_instance#

Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

instance (required)#

Name or id of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

The policy describes the baseline against which Instance boot integrity is measured.

Type: object

{
  "updateAutoLearnPolicy" : "Updates the integrity policy baseline using the measurements from the VM instance's most recent boot."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_ssl_certificates_for_region_target_https_proxy#

Replaces SslCertificates for TargetHttpsProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource to set an SslCertificates resource for.

Type: string

$body#

Type: object

{
  "sslCertificates" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_ssl_certificates_for_target_https_proxy#

Replaces SslCertificates for TargetHttpsProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource to set an SslCertificates resource for.

Type: string

$body#

Type: object

{
  "sslCertificates" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_ssl_certificates_for_target_ssl_proxy#

Changes SslCertificates for TargetSslProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetSslProxy (required)#

Name of the TargetSslProxy resource whose SslCertificate resource is to be set.

Type: string

$body#

Type: object

{
  "sslCertificates" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_ssl_policy_for_target_https_proxy#

Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.

Type: string

$body#

Type: object

{
  "sslPolicy" : "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_ssl_policy_for_target_ssl_proxy#

Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.

Parameters

project (required)#

Project ID for this request.

Type: string

targetSslProxy (required)#

Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.

Type: string

$body#

Type: object

{
  "sslPolicy" : "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_tags_for_instance#

Sets network tags for the specified instance to the data included in the request.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

A set of instance tags.

Type: object

{
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make get() request to the instance.",
  "items" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_target_for_forwarding_rule#

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Parameters

forwardingRule (required)#

Name of the ForwardingRule resource in which target is to be set.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "target" : "string"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_target_for_global_forwarding_rule#

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

Parameters

forwardingRule (required)#

Name of the ForwardingRule resource in which target is to be set.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "target" : "string"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_target_pools_for_instance_group_manager#

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Parameters

instanceGroupManager (required)#

The name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone where the managed instance group is located.

Type: string

$body#

Type: object

{
  "fingerprint" : "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" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_target_pools_for_region_instance_group_manager#

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Parameters

instanceGroupManager (required)#

Name of the managed instance group.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Type: object

{
  "fingerprint" : "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" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_url_map_for_region_target_http_proxy#

Changes the URL map for TargetHttpProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetHttpProxy (required)#

Name of the TargetHttpProxy to set a URL map for.

Type: string

$body#

Type: object

{
  "urlMap" : "string"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_url_map_for_region_target_https_proxy#

Changes the URL map for TargetHttpsProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy to set a URL map for.

Type: string

$body#

Type: object

{
  "urlMap" : "string"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_url_map_for_target_http_proxy#

Changes the URL map for TargetHttpProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpProxy (required)#

Name of the TargetHttpProxy to set a URL map for.

Type: string

$body#

Type: object

{
  "urlMap" : "string"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_url_map_for_target_https_proxy#

Changes the URL map for TargetHttpsProxy.

Parameters

project (required)#

Project ID for this request.

Type: string

targetHttpsProxy (required)#

Name of the TargetHttpsProxy resource whose URL map is to be set.

Type: string

$body#

Type: object

{
  "urlMap" : "string"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

set_usage_export_bucket_for_project#

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Parameters

project (required)#

Project ID for this request.

Type: string

$body#

The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.

Type: object

{
  "bucketName" : "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" : "An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. 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."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

simulate_maintenance_event_for_instance#

Simulates a maintenance event on the instance.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

start_instance#

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters

instance (required)#

Name of the instance resource to start.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

start_instance_with_encryption_key#

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters

instance (required)#

Name of the instance resource to start.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "disks" : [ {
    "diskEncryptionKey" : {
      "rawKey" : "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
      "sha256" : "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
      "kmsKeyName" : "The name of the encryption key that is stored in Google Cloud KMS."
    },
    "source" : "Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks."
  } ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

stop_instance#

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Parameters

instance (required)#

Name of the instance resource to stop.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

switch_network_to_custom_mode#

Switches the network mode from auto subnet mode to custom subnet mode.

Parameters

network (required)#

Name of the network to be updated.

Type: string

project (required)#

Project ID for this request.

Type: string

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_disk#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_external_vpn_gateway#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_image#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_instance#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_instance_template#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_license#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_license_code#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_network_endpoint_group#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_node_group#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_node_template#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_region_disk#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_reservation#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_resource_policy#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_snapshot#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_subnetwork#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

test_iam_permissions_for_vpn_gateway#

Returns permissions that a caller has on the specified resource.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

The name of the region for this request.

Type: string

resource (required)#

Name or id of the resource for this request.

Type: string

$body#

Type: object

{
  "permissions" : [ "string" ]
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_access_config_for_instance#

Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

instance (required)#

The instance name for this request.

Type: string

networkInterface (required)#

The name of the network interface where the access config is attached.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

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

Type: object

{
  "natIP" : "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" : "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.\n\nIf an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.\n\nIf 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.",
  "kind" : "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
  "name" : "The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.",
  "publicPtrDomainName" : "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.",
  "setPublicPtr" : "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.",
  "type" : "The type of configuration. The default and only option is ONE_TO_ONE_NAT."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_autoscaler#

Updates an autoscaler in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

zone (required)#

Name of the zone for this request.

Type: string

$body#

Represents an Autoscaler resource.

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. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Type: object

{
  "zone" : "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).",
  "kind" : "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "statusDetails" : [ {
    "message" : "The status message.",
    "type" : "The type of error returned."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
  "autoscalingPolicy" : {
    "cpuUtilization" : {
      "utilizationTarget" : "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales down 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.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization."
    },
    "loadBalancingUtilization" : {
      "utilizationTarget" : "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8."
    },
    "minNumReplicas" : "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.",
    "coolDownPeriodSec" : "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
    "customMetricUtilizations" : [ {
      "utilizationTargetType" : "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
      "metric" : "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.\n\nThe metric must have a value type of INT64 or DOUBLE.",
      "utilizationTarget" : "The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances."
    } ],
    "maxNumReplicas" : "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas."
  },
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "status" : "[Output Only] The status of the autoscaler configuration.",
  "target" : "URL of the managed instance group that this autoscaler will scale."
}

alt#

Data format for the response.

Type: string

Potential values: json

autoscaler#

Name of the autoscaler to update.

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_backend_bucket#

Updates the specified BackendBucket resource with the data included in the request.

Parameters

backendBucket (required)#

Name of the BackendBucket resource to update.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

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.

Type: object

{
  "bucketName" : "Cloud Storage bucket name.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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" ]
  },
  "enableCdn" : "If true, enable Cloud CDN for this BackendBucket.",
  "kind" : "Type of the resource.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional textual description of the resource; provided by the client when the resource is created.",
  "id" : "[Output Only] Unique identifier for the resource; defined by the server.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_backend_service#

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Parameters

backendService (required)#

Name of the BackendService resource to update.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Type: object

{
  "affinityCookieTtlSec" : "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 one day (86,400).",
  "healthChecks" : [ "string" ],
  "customRequestHeaders" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#backendService for backend services.",
  "sessionAffinity" : "Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.\n\nWhen the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "loadBalancingScheme" : "Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.",
  "portName" : "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nMust be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing).",
  "securityPolicy" : "[Output Only] The resource URL for the security policy associated with this backend service.",
  "backends" : [ {
    "maxConnectionsPerEndpoint" : "Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.",
    "maxConnectionsPerInstance" : "Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.",
    "capacityScaler" : "A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].\n\nThis cannot be used for internal load balancing.",
    "maxRatePerInstance" : "Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxRatePerEndpoint" : "Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.\n\nIf the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxUtilization" : "Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.\n\nThis parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "balancingMode" : "Specifies the balancing mode for the backend.\n\nWhen choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).\n\n \n- If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.\nYou can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.\n\nIf the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nIf the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.\n \n- If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).\nYou can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint.\n \n- If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group.\nYou can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.",
    "maxRate" : "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.\n\nThis cannot be used for internal load balancing.",
    "group" : "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.  \n\nYou 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" : "Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION."
  } ],
  "timeoutSec" : "The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "protocol" : "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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.",
    "cacheKeyPolicy" : {
      "includeHost" : "If true, requests to different hosts will be cached separately.",
      "includeProtocol" : "If true, http and https requests will be cached separately.",
      "queryStringWhitelist" : [ "string" ],
      "queryStringBlacklist" : [ "string" ],
      "includeQueryString" : "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."
    },
    "signedUrlKeyNames" : [ "string" ]
  },
  "enableCDN" : "If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.",
  "port" : "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.\n\nThis cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a BackendService.",
  "name" : "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.",
  "iap" : {
    "oauth2ClientSecretSha256" : "[Output Only] SHA256 hash value for the field oauth2_client_secret above.",
    "oauth2ClientId" : "string",
    "oauth2ClientSecret" : "string",
    "enabled" : "boolean"
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[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.",
  "connectionDraining" : {
    "drainingTimeoutSec" : "The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_display_device_for_instance#

Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

instance (required)#

Name of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

A set of Display Device options

Type: object

{
  "enableDisplay" : "Defines whether the instance has Display enabled."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_firewall#

Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags.

Parameters

firewall (required)#

Name of the firewall rule to update.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

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.

Type: object

{
  "sourceServiceAccounts" : [ "string" ],
  "logConfig" : {
    "enable" : "This field denotes whether to enable logging for a particular firewall rule."
  },
  "allowed" : [ {
    "IPProtocol" : "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" ]
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#firewall for firewall rules.",
  "description" : "An optional description of this resource. Provide this field when you create the resource.",
  "targetTags" : [ "string" ],
  "priority" : "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`.",
  "network" : "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:\nglobal/networks/default\nIf 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:  \n- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network \n- projects/myproject/global/networks/my-network \n- global/networks/default",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "targetServiceAccounts" : [ "string" ],
  "sourceRanges" : [ "string" ],
  "sourceTags" : [ "string" ],
  "destinationRanges" : [ "string" ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "disabled" : "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" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "denied" : [ {
    "IPProtocol" : "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" ]
  } ],
  "direction" : "Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_health_check#

Updates a HealthCheck resource in the specified project using the data included in the request.

Parameters

healthCheck (required)#

Name of the HealthCheck resource to update.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "tcpHealthCheck" : {
    "request" : "The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, TCP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "type" : "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "httpsHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTPS health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTPS health check request. The default value is /."
  },
  "sslHealthCheck" : {
    "request" : "The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, SSL health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "http2HealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP2 health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP/2 health check request. The default value is /."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in 3339 text format.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "httpHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP health check request. The default value is /."
  },
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] Region where the health check resides. Not applicable to global health checks."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_http_health_check#

Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Parameters

httpHealthCheck (required)#

Name of the HttpHealthCheck resource to update.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a legacy HTTP Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "port" : "The TCP port number for the HTTP health check request. The default value is 80.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "host" : "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.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "requestPath" : "The request path of the HTTP health check request. The default value is /. This field does not support query parameters."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_https_health_check#

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Parameters

httpsHealthCheck (required)#

Name of the HttpsHealthCheck resource to update.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "port" : "The TCP port number for the HTTPS health check request. The default value is 443.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "host" : "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.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "requestPath" : "The request path of the HTTPS health check request. The default value is \"/\"."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_network_interface_for_instance#

Updates an instance's network interface. This method follows PATCH semantics.

Parameters

instance (required)#

The instance name for this request.

Type: string

networkInterface (required)#

The name of the network interface to update.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

A network interface resource attached to an instance.

Type: object

{
  "aliasIpRanges" : [ {
    "ipCidrRange" : "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" : "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."
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.",
  "networkIP" : "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.",
  "subnetwork" : "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:  \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork \n- regions/region/subnetworks/subnetwork",
  "fingerprint" : "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, otherwise the request will fail with error 412 conditionNotMet.",
  "name" : "[Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.",
  "accessConfigs" : [ {
    "natIP" : "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" : "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.\n\nIf an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.\n\nIf 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.",
    "kind" : "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
    "name" : "The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.",
    "publicPtrDomainName" : "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.",
    "setPublicPtr" : "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.",
    "type" : "The type of configuration. The default and only option is ONE_TO_ONE_NAT."
  } ],
  "network" : "URL of the 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 network is not specified but the subnetwork is specified, the network is inferred.\n\nIf you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:  \n- https://www.googleapis.com/compute/v1/projects/project/global/networks/network \n- projects/project/global/networks/network \n- global/networks/default"
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_peering_for_network#

Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes

Parameters

network (required)#

Name of the network resource which the updated peering is belonging to.

Type: string

project (required)#

Project ID for this request.

Type: string

$body#

Type: object

{
  "networkPeering" : {
    "exchangeSubnetRoutes" : "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.",
    "autoCreateRoutes" : "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.",
    "name" : "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.",
    "state" : "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.",
    "exportCustomRoutes" : "Whether to export the custom routes to peer network.",
    "stateDetails" : "[Output Only] Details about the current state of the peering.",
    "importCustomRoutes" : "Whether to import the custom routes from peer network.",
    "network" : "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."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_region_autoscaler#

Updates an autoscaler in the specified project using the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents an Autoscaler resource.

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. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Type: object

{
  "zone" : "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).",
  "kind" : "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "statusDetails" : [ {
    "message" : "The status message.",
    "type" : "The type of error returned."
  } ],
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
  "autoscalingPolicy" : {
    "cpuUtilization" : {
      "utilizationTarget" : "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales down 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.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization."
    },
    "loadBalancingUtilization" : {
      "utilizationTarget" : "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8."
    },
    "minNumReplicas" : "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.",
    "coolDownPeriodSec" : "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
    "customMetricUtilizations" : [ {
      "utilizationTargetType" : "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
      "metric" : "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.\n\nThe metric must have a value type of INT64 or DOUBLE.",
      "utilizationTarget" : "The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances."
    } ],
    "maxNumReplicas" : "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas."
  },
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "status" : "[Output Only] The status of the autoscaler configuration.",
  "target" : "URL of the managed instance group that this autoscaler will scale."
}

alt#

Data format for the response.

Type: string

Potential values: json

autoscaler#

Name of the autoscaler to update.

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_region_backend_service#

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Parameters

backendService (required)#

Name of the BackendService resource to update.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Type: object

{
  "affinityCookieTtlSec" : "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 one day (86,400).",
  "healthChecks" : [ "string" ],
  "customRequestHeaders" : [ "string" ],
  "kind" : "[Output Only] Type of resource. Always compute#backendService for backend services.",
  "sessionAffinity" : "Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.\n\nWhen the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "loadBalancingScheme" : "Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.",
  "portName" : "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nMust be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing).",
  "securityPolicy" : "[Output Only] The resource URL for the security policy associated with this backend service.",
  "backends" : [ {
    "maxConnectionsPerEndpoint" : "Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.",
    "maxConnectionsPerInstance" : "Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.",
    "capacityScaler" : "A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].\n\nThis cannot be used for internal load balancing.",
    "maxRatePerInstance" : "Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxRatePerEndpoint" : "Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.\n\nIf the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance.\n\nNot available if the backend's balancingMode is CONNECTION.",
    "maxUtilization" : "Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.\n\nThis parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "balancingMode" : "Specifies the balancing mode for the backend.\n\nWhen choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).\n\n \n- If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.\nYou can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.\n\nIf the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nIf the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.\n \n- If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).\nYou can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint.\n \n- If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group.\nYou can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.",
    "maxRate" : "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.\n\nThis cannot be used for internal load balancing.",
    "group" : "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.  \n\nYou 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" : "Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION."
  } ],
  "timeoutSec" : "The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "protocol" : "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information.",
  "cdnPolicy" : {
    "signedUrlCacheMaxAgeSec" : "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.",
    "cacheKeyPolicy" : {
      "includeHost" : "If true, requests to different hosts will be cached separately.",
      "includeProtocol" : "If true, http and https requests will be cached separately.",
      "queryStringWhitelist" : [ "string" ],
      "queryStringBlacklist" : [ "string" ],
      "includeQueryString" : "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."
    },
    "signedUrlKeyNames" : [ "string" ]
  },
  "enableCDN" : "If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.",
  "port" : "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.\n\nThis cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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.\n\nTo see the latest fingerprint, make a get() request to retrieve a BackendService.",
  "name" : "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.",
  "iap" : {
    "oauth2ClientSecretSha256" : "[Output Only] SHA256 hash value for the field oauth2_client_secret above.",
    "oauth2ClientId" : "string",
    "oauth2ClientSecret" : "string",
    "enabled" : "boolean"
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[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.",
  "connectionDraining" : {
    "drainingTimeoutSec" : "The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_region_health_check#

Updates a HealthCheck resource in the specified project using the data included in the request.

Parameters

healthCheck (required)#

Name of the HealthCheck resource to update.

Type: string

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

$body#

Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Type: object

{
  "checkIntervalSec" : "How often (in seconds) to send a health check. The default value is 5 seconds.",
  "kind" : "Type of the resource.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "tcpHealthCheck" : {
    "request" : "The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, TCP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "type" : "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.",
  "timeoutSec" : "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.",
  "selfLink" : "[Output Only] Server-defined URL for the resource.",
  "httpsHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTPS health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTPS health check request. The default value is /."
  },
  "sslHealthCheck" : {
    "request" : "The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, SSL health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
  },
  "http2HealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP2 health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP/2 health check request. The default value is /."
  },
  "creationTimestamp" : "[Output Only] Creation timestamp in 3339 text format.",
  "name" : "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.",
  "unhealthyThreshold" : "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
  "httpHealthCheck" : {
    "port" : "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
    "response" : "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
    "host" : "The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
    "portName" : "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
    "portSpecification" : "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in\nport\nis used for health checking.\nUSE_NAMED_PORT: The\nportName\nis used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP health check follows behavior specified in\nport\nand\nportName\nfields.",
    "proxyHeader" : "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
    "requestPath" : "The request path of the HTTP health check request. The default value is /."
  },
  "healthyThreshold" : "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "region" : "[Output Only] Region where the health check resides. Not applicable to global health checks."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_region_url_map#

Updates the specified UrlMap resource with the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to update.

Type: string

$body#

Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

Type: object

{
  "tests" : [ {
    "path" : "Path portion of the URL.",
    "service" : "Expected BackendService resource the given URL should be mapped to.",
    "host" : "Host portion of the URL.",
    "description" : "Description of this test case."
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
  "hostRules" : [ {
    "hosts" : [ "string" ],
    "pathMatcher" : "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
    "description" : "An optional description of this resource. Provide this property when you create the resource."
  } ],
  "pathMatchers" : [ {
    "pathRules" : [ {
      "paths" : [ "string" ],
      "service" : "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any  weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
    } ],
    "name" : "The name to which this PathMatcher is referred by the HostRule.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "defaultService" : "The full or partial URL to the BackendService resource. This will be 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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService  If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service:  \n- compute.backendBuckets.use \n- compute.backendServices.use"
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "defaultService" : "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.",
  "region" : "[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" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_router#

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region for this request.

Type: string

router (required)#

Name of the Router resource to update.

Type: string

$body#

Represents a Cloud Router resource.

For more information about Cloud Router, read the the Cloud Router overview.

Type: object

{
  "nats" : [ {
    "udpIdleTimeoutSec" : "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.",
    "logConfig" : {
      "filter" : "Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT.",
      "enable" : "Indicates whether or not to export logs. This is false by default."
    },
    "sourceSubnetworkIpRangesToNat" : "Specify the Nat option, which can take one of the following values: \n- ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. \n- ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. \n- 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 or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.",
    "minPortsPerVm" : "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.",
    "tcpEstablishedIdleTimeoutSec" : "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.",
    "name" : "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.",
    "natIpAllocateOption" : "Specify the NatIpAllocateOption, which can take one of the following values: \n- 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. \n- 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.",
    "natIps" : [ "string" ],
    "tcpTransitoryIdleTimeoutSec" : "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.",
    "icmpIdleTimeoutSec" : "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.",
    "subnetworks" : [ {
      "sourceIpRangesToNat" : [ "string. Possible values: ALL_IP_RANGES | LIST_OF_SECONDARY_IP_RANGES | PRIMARY_IP_RANGE" ],
      "secondaryIpRangeNames" : [ "string" ],
      "name" : "URL for the subnetwork resource that will use NAT."
    } ]
  } ],
  "interfaces" : [ {
    "ipRange" : "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.",
    "name" : "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.",
    "linkedVpnTunnel" : "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 either a VPN tunnel or an Interconnect attachment.",
    "linkedInterconnectAttachment" : "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 either be a VPN tunnel or an Interconnect attachment.",
    "managementType" : "[Output Only] The resource that configures and manages this interface. \n- MANAGED_BY_USER is the default value and can be managed directly by users. \n- 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."
  } ],
  "kind" : "[Output Only] Type of resource. Always compute#router for routers.",
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "bgp" : {
    "advertiseMode" : "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.",
    "advertisedGroups" : [ "string. Possible values: ALL_SUBNETS" ],
    "advertisedIpRanges" : [ {
      "description" : "User-specified description for the IP range.",
      "range" : "The IP range to advertise. The value must be a CIDR-formatted string."
    } ],
    "asn" : "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."
  },
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "bgpPeers" : [ {
    "advertisedRoutePriority" : "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.",
    "peerIpAddress" : "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.",
    "advertiseMode" : "User-specified flag to indicate which mode to use for advertisement.",
    "advertisedGroups" : [ "string. Possible values: ALL_SUBNETS" ],
    "ipAddress" : "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.",
    "name" : "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.",
    "interfaceName" : "Name of the interface the BGP peer is associated with.",
    "advertisedIpRanges" : [ {
      "description" : "User-specified description for the IP range.",
      "range" : "The IP range to advertise. The value must be a CIDR-formatted string."
    } ],
    "peerAsn" : "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.",
    "managementType" : "[Output Only] The resource that configures and manages this BGP peer. \n- MANAGED_BY_USER is the default value and can be managed by you or other users \n- 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."
  } ],
  "region" : "[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.",
  "network" : "URI of the network to which this router belongs.",
  "selfLink" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_shielded_instance_config_for_instance#

Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

instance (required)#

Name or id of the instance scoping this request.

Type: string

project (required)#

Project ID for this request.

Type: string

zone (required)#

The name of the zone for this request.

Type: string

$body#

A set of Shielded Instance options.

Type: object

{
  "enableVtpm" : "Defines whether the instance has the vTPM enabled.",
  "enableIntegrityMonitoring" : "Defines whether the instance has integrity monitoring enabled.",
  "enableSecureBoot" : "Defines whether the instance has Secure Boot enabled."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

update_url_map#

Updates the specified UrlMap resource with the data included in the request.

Parameters

project (required)#

Project ID for this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to update.

Type: string

$body#

Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

Type: object

{
  "tests" : [ {
    "path" : "Path portion of the URL.",
    "service" : "Expected BackendService resource the given URL should be mapped to.",
    "host" : "Host portion of the URL.",
    "description" : "Description of this test case."
  } ],
  "kind" : "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
  "hostRules" : [ {
    "hosts" : [ "string" ],
    "pathMatcher" : "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
    "description" : "An optional description of this resource. Provide this property when you create the resource."
  } ],
  "pathMatchers" : [ {
    "pathRules" : [ {
      "paths" : [ "string" ],
      "service" : "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any  weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
    } ],
    "name" : "The name to which this PathMatcher is referred by the HostRule.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "defaultService" : "The full or partial URL to the BackendService resource. This will be 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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService  If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service:  \n- compute.backendBuckets.use \n- compute.backendServices.use"
  } ],
  "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
  "fingerprint" : "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
  "name" : "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.",
  "description" : "An optional description of this resource. Provide this property when you create the resource.",
  "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
  "defaultService" : "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.",
  "region" : "[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" : "[Output Only] Server-defined URL for the resource."
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

requestId#

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

validate_region_url_map#

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters

project (required)#

Project ID for this request.

Type: string

region (required)#

Name of the region scoping this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to be validated as.

Type: string

$body#

Type: object

{
  "resource" : {
    "tests" : [ {
      "path" : "Path portion of the URL.",
      "service" : "Expected BackendService resource the given URL should be mapped to.",
      "host" : "Host portion of the URL.",
      "description" : "Description of this test case."
    } ],
    "kind" : "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
    "hostRules" : [ {
      "hosts" : [ "string" ],
      "pathMatcher" : "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
      "description" : "An optional description of this resource. Provide this property when you create the resource."
    } ],
    "pathMatchers" : [ {
      "pathRules" : [ {
        "paths" : [ "string" ],
        "service" : "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any  weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
      } ],
      "name" : "The name to which this PathMatcher is referred by the HostRule.",
      "description" : "An optional description of this resource. Provide this property when you create the resource.",
      "defaultService" : "The full or partial URL to the BackendService resource. This will be 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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService  If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service:  \n- compute.backendBuckets.use \n- compute.backendServices.use"
    } ],
    "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
    "fingerprint" : "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
    "name" : "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.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
    "defaultService" : "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.",
    "region" : "[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" : "[Output Only] Server-defined URL for the resource."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string

validate_url_map#

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters

project (required)#

Project ID for this request.

Type: string

urlMap (required)#

Name of the UrlMap resource to be validated as.

Type: string

$body#

Type: object

{
  "resource" : {
    "tests" : [ {
      "path" : "Path portion of the URL.",
      "service" : "Expected BackendService resource the given URL should be mapped to.",
      "host" : "Host portion of the URL.",
      "description" : "Description of this test case."
    } ],
    "kind" : "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
    "hostRules" : [ {
      "hosts" : [ "string" ],
      "pathMatcher" : "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
      "description" : "An optional description of this resource. Provide this property when you create the resource."
    } ],
    "pathMatchers" : [ {
      "pathRules" : [ {
        "paths" : [ "string" ],
        "service" : "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any  weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
      } ],
      "name" : "The name to which this PathMatcher is referred by the HostRule.",
      "description" : "An optional description of this resource. Provide this property when you create the resource.",
      "defaultService" : "The full or partial URL to the BackendService resource. This will be 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:  \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService  If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service:  \n- compute.backendBuckets.use \n- compute.backendServices.use"
    } ],
    "creationTimestamp" : "[Output Only] Creation timestamp in RFC3339 text format.",
    "fingerprint" : "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
    "name" : "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.",
    "description" : "An optional description of this resource. Provide this property when you create the resource.",
    "id" : "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
    "defaultService" : "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.\nOnly one of defaultService, defaultUrlRedirect  or defaultRouteAction.weightedBackendService must be set.",
    "region" : "[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" : "[Output Only] Server-defined URL for the resource."
  }
}

alt#

Data format for the response.

Type: string

Potential values: json

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Type: string

userIp#

Deprecated. Please use quotaUser instead.

Type: string