As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Compute v1 API

class google.cloud.compute_v1.types.AWSV4Signature(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Messages

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

access_key

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

This field is a member of oneof _access_key.

Type

str

access_key_id

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

This field is a member of oneof _access_key_id.

Type

str

access_key_version

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

This field is a member of oneof _access_key_version.

Type

str

origin_region

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

This field is a member of oneof _origin_region.

Type

str

class google.cloud.compute_v1.types.AbandonInstancesInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.AbandonInstances. See the method description for details.

instance_group_manager

The name of the managed instance group.

Type

str

instance_group_managers_abandon_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersAbandonInstancesRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.AbandonInstancesRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.AbandonInstances. See the method description for details.

instance_group_manager

Name of the managed instance group.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_instance_group_managers_abandon_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagersAbandonInstancesRequest

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AcceleratorConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

accelerator_count

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

This field is a member of oneof _accelerator_count.

Type

int

accelerator_type

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.

This field is a member of oneof _accelerator_type.

Type

str

class google.cloud.compute_v1.types.AcceleratorType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

deprecated

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

This field is a member of oneof _deprecated.

Type

google.cloud.compute_v1.types.DeprecationStatus

description

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

This field is a member of oneof _description.

Type

str

id

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

This field is a member of oneof _id.

Type

int

kind

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

This field is a member of oneof _kind.

Type

str

maximum_cards_per_instance

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

This field is a member of oneof _maximum_cards_per_instance.

Type

int

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

zone

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

This field is a member of oneof _zone.

Type

str

class google.cloud.compute_v1.types.AcceleratorTypeAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of AcceleratorTypesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.AcceleratorTypesScopedList]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.AcceleratorTypeList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of accelerator types.

id

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

This field is a member of oneof _id.

Type

str

items

A list of AcceleratorType resources.

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorType]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.AcceleratorTypesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

accelerator_types

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

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorType]

warning

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

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.Accelerators(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

guest_accelerator_count

Number of accelerator cards exposed to the guest.

This field is a member of oneof _guest_accelerator_count.

Type

int

guest_accelerator_type

The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4.

This field is a member of oneof _guest_accelerator_type.

Type

str

class google.cloud.compute_v1.types.AccessConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

external_ipv6

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

This field is a member of oneof _external_ipv6.

Type

str

external_ipv6_prefix_length

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

This field is a member of oneof _external_ipv6_prefix_length.

Type

int

kind

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

This field is a member of oneof _kind.

Type

str

name

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

This field is a member of oneof _name.

Type

str

nat_i_p

Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

This field is a member of oneof _nat_i_p.

Type

str

network_tier

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

This field is a member of oneof _network_tier.

Type

str

public_ptr_domain_name

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

This field is a member of oneof _public_ptr_domain_name.

Type

str

security_policy

[Output Only] The resource URL for the security policy associated with this access config.

This field is a member of oneof _security_policy.

Type

str

set_public_ptr

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

This field is a member of oneof _set_public_ptr.

Type

bool

type_

The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class NetworkTier(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_NETWORK_TIER (0):

A value indicating that the enum field is not set.

FIXED_STANDARD (310464328):

Public internet quality with fixed bandwidth.

PREMIUM (399530551):

High quality, Google-grade network tier, support for all networking products.

STANDARD (484642493):

Public internet quality, only limited support for other networking products.

STANDARD_OVERRIDES_FIXED_STANDARD (465847234):

(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

class Type(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

DIRECT_IPV6 (4397213):

No description available.

ONE_TO_ONE_NAT (84090205):

No description available.

class google.cloud.compute_v1.types.AddAccessConfigInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.AddAccessConfig. See the method description for details.

access_config_resource

The body resource for this request

Type

google.cloud.compute_v1.types.AccessConfig

instance

The instance name for this request.

Type

str

network_interface

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

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.AddAssociationFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.AddAssociation. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_association_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyAssociation

replace_existing_association

Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.

This field is a member of oneof _replace_existing_association.

Type

bool

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AddAssociationNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.AddAssociation. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_association_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyAssociation

project

Project ID for this request.

Type

str

replace_existing_association

Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.

This field is a member of oneof _replace_existing_association.

Type

bool

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AddAssociationRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.AddAssociation. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_association_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyAssociation

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

replace_existing_association

Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.

This field is a member of oneof _replace_existing_association.

Type

bool

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AddHealthCheckTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.AddHealthCheck. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_pool

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

Type

str

target_pools_add_health_check_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetPoolsAddHealthCheckRequest

class google.cloud.compute_v1.types.AddInstanceTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.AddInstance. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_pool

Name of the TargetPool resource to add instances to.

Type

str

target_pools_add_instance_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetPoolsAddInstanceRequest

class google.cloud.compute_v1.types.AddInstancesInstanceGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.AddInstances. See the method description for details.

instance_group

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

Type

str

instance_groups_add_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupsAddInstancesRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.AddNodesNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.AddNodes. See the method description for details.

node_group

Name of the NodeGroup resource.

Type

str

node_groups_add_nodes_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NodeGroupsAddNodesRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.AddPeeringNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.AddPeering. See the method description for details.

network

Name of the network resource to add peering to.

Type

str

networks_add_peering_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworksAddPeeringRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AddResourcePoliciesDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.AddResourcePolicies. See the method description for details.

disk

The disk name for this request.

Type

str

disks_add_resource_policies_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DisksAddResourcePoliciesRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.AddResourcePoliciesInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.AddResourcePolicies. See the method description for details.

instance

The instance name for this request.

Type

str

instances_add_resource_policies_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesAddResourcePoliciesRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.AddResourcePoliciesRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.AddResourcePolicies. See the method description for details.

disk

The disk name for this request.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_disks_add_resource_policies_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionDisksAddResourcePoliciesRequest

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AddRuleFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.AddRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyRule

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AddRuleNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.AddRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyRule

max_priority

When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

This field is a member of oneof _max_priority.

Type

int

min_priority

When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

This field is a member of oneof _min_priority.

Type

int

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AddRuleRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.AddRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyRule

max_priority

When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

This field is a member of oneof _max_priority.

Type

int

min_priority

When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

This field is a member of oneof _min_priority.

Type

int

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AddRuleRegionSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.AddRule. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

security_policy

Name of the security policy to update.

Type

str

security_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyRule

validate_only

If true, the request will not be committed.

This field is a member of oneof _validate_only.

Type

bool

class google.cloud.compute_v1.types.AddRuleSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.AddRule. See the method description for details.

project

Project ID for this request.

Type

str

security_policy

Name of the security policy to update.

Type

str

security_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyRule

validate_only

If true, the request will not be committed.

This field is a member of oneof _validate_only.

Type

bool

class google.cloud.compute_v1.types.AddSignedUrlKeyBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.AddSignedUrlKey. See the method description for details.

backend_bucket

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

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

signed_url_key_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SignedUrlKey

class google.cloud.compute_v1.types.AddSignedUrlKeyBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.AddSignedUrlKey. See the method description for details.

backend_service

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

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

signed_url_key_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SignedUrlKey

class google.cloud.compute_v1.types.Address(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

address

The static IP address represented by this resource.

This field is a member of oneof _address.

Type

str

address_type

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Check the AddressType enum for the list of possible values.

This field is a member of oneof _address_type.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

id

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

This field is a member of oneof _id.

Type

int

ip_version

The IP version that will be used by this address. Valid options are IPV4 or IPV6. Check the IpVersion enum for the list of possible values.

This field is a member of oneof _ip_version.

Type

str

ipv6_endpoint_type

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

This field is a member of oneof _ipv6_endpoint_type.

Type

str

kind

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

This field is a member of oneof _kind.

Type

str

label_fingerprint

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

This field is a member of oneof _label_fingerprint.

Type

str

labels

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

Type

MutableMapping[str, str]

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.

This field is a member of oneof _name.

Type

str

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.

This field is a member of oneof _network.

Type

str

network_tier

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

This field is a member of oneof _network_tier.

Type

str

prefix_length

The prefix length if the resource represents an IP range.

This field is a member of oneof _prefix_length.

Type

int

purpose

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

This field is a member of oneof _purpose.

Type

str

region

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

This field is a member of oneof _region.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

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. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

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.

This field is a member of oneof _subnetwork.

Type

str

users

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

Type

MutableSequence[str]

class AddressType(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_ADDRESS_TYPE (0):

A value indicating that the enum field is not set.

EXTERNAL (35607499):

A publicly visible external IP address.

INTERNAL (279295677):

A private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.

UNSPECIFIED_TYPE (53933922):

No description available.

class IpVersion(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_IP_VERSION (0):

A value indicating that the enum field is not set.

IPV4 (2254341):

No description available.

IPV6 (2254343):

No description available.

UNSPECIFIED_VERSION (21850000):

No description available.

class Ipv6EndpointType(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_IPV6_ENDPOINT_TYPE (0):

A value indicating that the enum field is not set.

NETLB (74173363):

Reserved IPv6 address can be used on network load balancer.

VM (2743):

Reserved IPv6 address can be used on VM.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class NetworkTier(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_NETWORK_TIER (0):

A value indicating that the enum field is not set.

FIXED_STANDARD (310464328):

Public internet quality with fixed bandwidth.

PREMIUM (399530551):

High quality, Google-grade network tier, support for all networking products.

STANDARD (484642493):

Public internet quality, only limited support for other networking products.

STANDARD_OVERRIDES_FIXED_STANDARD (465847234):

(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

class Purpose(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_PURPOSE (0):

A value indicating that the enum field is not set.

DNS_RESOLVER (476114556):

DNS resolver address in the subnetwork.

GCE_ENDPOINT (230515243):

VM internal/alias IP, Internal LB service IP, etc.

IPSEC_INTERCONNECT (340437251):

A regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.

NAT_AUTO (163666477):

External IP automatically reserved for Cloud NAT.

PRIVATE_SERVICE_CONNECT (48134724):

A private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL

SERVERLESS (270492508):

A regional internal IP address range reserved for Serverless.

SHARED_LOADBALANCER_VIP (294447572):

A private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.

VPC_PEERING (400800170):

IP range for peer networks.

class Status(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

IN_USE (17393485):

Address is being used by another resource and is not available.

RESERVED (432241448):

Address is reserved and available to use.

RESERVING (514587225):

Address is being reserved.

class google.cloud.compute_v1.types.AddressAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of AddressesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.AddressesScopedList]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.AddressList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of addresses.

id

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

This field is a member of oneof _id.

Type

str

items

A list of Address resources.

Type

MutableSequence[google.cloud.compute_v1.types.Address]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.AddressesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

addresses

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

Type

MutableSequence[google.cloud.compute_v1.types.Address]

warning

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

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.AdvancedMachineFeatures(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

enable_nested_virtualization

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

This field is a member of oneof _enable_nested_virtualization.

Type

bool

enable_uefi_networking

Whether to enable UEFI networking for instance creation.

This field is a member of oneof _enable_uefi_networking.

Type

bool

performance_monitoring_unit

Type of Performance Monitoring Unit requested on instance. Check the PerformanceMonitoringUnit enum for the list of possible values.

This field is a member of oneof _performance_monitoring_unit.

Type

str

threads_per_core

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

This field is a member of oneof _threads_per_core.

Type

int

turbo_mode

Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode.

This field is a member of oneof _turbo_mode.

Type

str

visible_core_count

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

This field is a member of oneof _visible_core_count.

Type

int

class PerformanceMonitoringUnit(value)

Bases: proto.enums.Enum

Type of Performance Monitoring Unit requested on instance.

Values:

UNDEFINED_PERFORMANCE_MONITORING_UNIT (0):

A value indicating that the enum field is not set.

ARCHITECTURAL (155113693):

Architecturally defined non-LLC events.

ENHANCED (476873590):

Most documented core/L2 and LLC events.

PERFORMANCE_MONITORING_UNIT_UNSPECIFIED (429210692):

No description available.

STANDARD (484642493):

Most documented core/L2 events.

class google.cloud.compute_v1.types.AggregatedListAcceleratorTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for AcceleratorTypes.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListAddressesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Addresses.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListAutoscalersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Autoscalers.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListBackendServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListDiskTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for DiskTypes.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListDisksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListForwardingRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ForwardingRules.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListGlobalOperationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalOperations.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListHealthChecksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for HealthChecks.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListInstanceGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListInstanceTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceTemplates.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListInstantSnapshotsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListInterconnectAttachmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectAttachments.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListMachineTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineTypes.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListNetworkAttachmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListNetworkEdgeSecurityServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEdgeSecurityServices.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListNetworkEndpointGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListNodeGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListNodeTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTemplates.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListNodeTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTypes.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListPacketMirroringsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PacketMirrorings.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListPublicDelegatedPrefixesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicDelegatedPrefixes.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListRegionCommitmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionCommitments.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListReservationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListResourcePoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListRoutersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListSecurityPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListServiceAttachmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListSslCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslCertificates.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListSslPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslPolicies.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListStoragePoolTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePoolTypes.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListStoragePoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListSubnetworksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListTargetHttpProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpProxies.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListTargetHttpsProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListTargetInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetInstances.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListTargetPoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListTargetTcpProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetTcpProxies.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListTargetVpnGatewaysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetVpnGateways.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListUrlMapsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Name of the project scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListVpnGatewaysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnGateways.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AggregatedListVpnTunnelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnTunnels.AggregatedList. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

include_all_scopes

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

This field is a member of oneof _include_all_scopes.

Type

bool

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

service_project_number

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

This field is a member of oneof _service_project_number.

Type

int

class google.cloud.compute_v1.types.AliasIpRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An alias IP range attached to an instance’s network interface.

ip_cidr_range

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

This field is a member of oneof _ip_cidr_range.

Type

str

subnetwork_range_name

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.

This field is a member of oneof _subnetwork_range_name.

Type

str

class google.cloud.compute_v1.types.AllocationAggregateReservation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation.

in_use_resources

[Output only] List of resources currently in use.

Type

MutableSequence[google.cloud.compute_v1.types.AllocationAggregateReservationReservedResourceInfo]

reserved_resources

List of reserved resources (CPUs, memory, accelerators).

Type

MutableSequence[google.cloud.compute_v1.types.AllocationAggregateReservationReservedResourceInfo]

vm_family

The VM family that all instances scheduled against this reservation must belong to. Check the VmFamily enum for the list of possible values.

This field is a member of oneof _vm_family.

Type

str

workload_type

The workload type of the instances that will target this reservation. Check the WorkloadType enum for the list of possible values.

This field is a member of oneof _workload_type.

Type

str

class VmFamily(value)

Bases: proto.enums.Enum

The VM family that all instances scheduled against this reservation must belong to.

Values:

UNDEFINED_VM_FAMILY (0):

A value indicating that the enum field is not set.

VM_FAMILY_CLOUD_TPU_DEVICE_CT3 (42845948):

No description available.

VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L (108020067):

No description available.

VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP (18705267):

No description available.

VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P (517384376):

No description available.

VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P (517384407):

No description available.

class WorkloadType(value)

Bases: proto.enums.Enum

The workload type of the instances that will target this reservation.

Values:

UNDEFINED_WORKLOAD_TYPE (0):

A value indicating that the enum field is not set.

BATCH (62971674):

Reserved resources will be optimized for BATCH workloads, such as ML training.

SERVING (17781740):

Reserved resources will be optimized for SERVING workloads, such as ML inference.

UNSPECIFIED (526786327):

No description available.

class google.cloud.compute_v1.types.AllocationAggregateReservationReservedResourceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

accelerator

Properties of accelerator resources in this reservation.

This field is a member of oneof _accelerator.

Type

google.cloud.compute_v1.types.AllocationAggregateReservationReservedResourceInfoAccelerator

class google.cloud.compute_v1.types.AllocationAggregateReservationReservedResourceInfoAccelerator(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

accelerator_count

Number of accelerators of specified type.

This field is a member of oneof _accelerator_count.

Type

int

accelerator_type

Full or partial URL to accelerator type. e.g. “projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l”.

This field is a member of oneof _accelerator_type.

Type

str

class google.cloud.compute_v1.types.AllocationResourceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] Contains output only fields.

specific_sku_allocation

Allocation Properties of this reservation.

This field is a member of oneof _specific_sku_allocation.

Type

google.cloud.compute_v1.types.AllocationResourceStatusSpecificSKUAllocation

class google.cloud.compute_v1.types.AllocationResourceStatusSpecificSKUAllocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains Properties set for the reservation.

source_instance_template_id

ID of the instance template used to populate reservation properties.

This field is a member of oneof _source_instance_template_id.

Type

str

class google.cloud.compute_v1.types.AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

disk_size_gb

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

This field is a member of oneof _disk_size_gb.

Type

int

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. Check the Interface enum for the list of possible values.

This field is a member of oneof _interface.

Type

str

class Interface(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_INTERFACE (0):

A value indicating that the enum field is not set.

NVME (2408800):

No description available.

SCSI (2539686):

No description available.

class google.cloud.compute_v1.types.AllocationSpecificSKUAllocationReservedInstanceProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Properties of the SKU instances being reserved. Next ID: 9

guest_accelerators

Specifies accelerator type and count.

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorConfig]

local_ssds

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

Type

MutableSequence[google.cloud.compute_v1.types.AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk]

location_hint

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

This field is a member of oneof _location_hint.

Type

str

machine_type

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.

This field is a member of oneof _machine_type.

Type

str

min_cpu_platform

Minimum cpu platform the reservation.

This field is a member of oneof _min_cpu_platform.

Type

str

class google.cloud.compute_v1.types.AllocationSpecificSKUReservation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This reservation type allows to pre allocate specific instance configuration.

assured_count

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

This field is a member of oneof _assured_count.

Type

int

count

Specifies the number of resources that are allocated.

This field is a member of oneof _count.

Type

int

in_use_count

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

This field is a member of oneof _in_use_count.

Type

int

instance_properties

The instance properties for the reservation.

This field is a member of oneof _instance_properties.

Type

google.cloud.compute_v1.types.AllocationSpecificSKUAllocationReservedInstanceProperties

source_instance_template

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

This field is a member of oneof _source_instance_template.

Type

str

class google.cloud.compute_v1.types.Allowed(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

I_p_protocol

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.

This field is a member of oneof _I_p_protocol.

Type

str

ports

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

Type

MutableSequence[str]

class google.cloud.compute_v1.types.AnnouncePublicAdvertisedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicAdvertisedPrefixes.Announce. See the method description for details.

project

Project ID for this request.

Type

str

public_advertised_prefix

The name of the public advertised prefix. It should comply with RFC1035.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AnnouncePublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicDelegatedPrefixes.Announce. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix

The name of the public delegated prefix. It should comply with RFC1035.

Type

str

region

The name of the region where the public delegated prefix is located. It should comply with RFC1035.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.ApplyUpdatesToInstancesInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.ApplyUpdatesToInstances. See the method description for details.

instance_group_manager

The name of the managed instance group, should conform to RFC1035.

Type

str

instance_group_managers_apply_updates_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersApplyUpdatesRequest

project

Project ID for this request.

Type

str

zone

The name of the zone where the managed instance group is located. Should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.ApplyUpdatesToInstances. See the method description for details.

instance_group_manager

The name of the managed instance group, should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request, should conform to RFC1035.

Type

str

region_instance_group_managers_apply_updates_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagersApplyUpdatesRequest

class google.cloud.compute_v1.types.AttachDiskInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.AttachDisk. See the method description for details.

attached_disk_resource

The body resource for this request

Type

google.cloud.compute_v1.types.AttachedDisk

force_attach

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

This field is a member of oneof _force_attach.

Type

bool

instance

The instance name for this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalNetworkEndpointGroups.AttachNetworkEndpoints. See the method description for details.

global_network_endpoint_groups_attach_endpoints_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalNetworkEndpointGroupsAttachEndpointsRequest

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AttachNetworkEndpointsNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.AttachNetworkEndpoints. See the method description for details.

network_endpoint_group

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

Type

str

network_endpoint_groups_attach_endpoints_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkEndpointGroupsAttachEndpointsRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.AttachNetworkEndpointsRegionNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkEndpointGroups.AttachNetworkEndpoints. See the method description for details.

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

region

The name of the region where you want to create the network endpoint group. It should comply with RFC1035.

Type

str

region_network_endpoint_groups_attach_endpoints_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionNetworkEndpointGroupsAttachEndpointsRequest

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.AttachedDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An instance-attached disk resource.

architecture

[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

This field is a member of oneof _architecture.

Type

str

auto_delete

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

This field is a member of oneof _auto_delete.

Type

bool

boot

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

This field is a member of oneof _boot.

Type

bool

device_name

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

This field is a member of oneof _device_name.

Type

str

disk_encryption_key

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

This field is a member of oneof _disk_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

disk_size_gb

The size of the disk in GB.

This field is a member of oneof _disk_size_gb.

Type

int

force_attach

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

This field is a member of oneof _force_attach.

Type

bool

guest_os_features

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

Type

MutableSequence[google.cloud.compute_v1.types.GuestOsFeature]

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.

This field is a member of oneof _index.

Type

int

initialize_params

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

This field is a member of oneof _initialize_params.

Type

google.cloud.compute_v1.types.AttachedDiskInitializeParams

interface

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

This field is a member of oneof _interface.

Type

str

kind

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

This field is a member of oneof _kind.

Type

str

licenses

[Output Only] Any valid publicly visible licenses.

Type

MutableSequence[str]

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. Check the Mode enum for the list of possible values.

This field is a member of oneof _mode.

Type

str

saved_state

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

This field is a member of oneof _saved_state.

Type

str

shielded_instance_initial_state

[Output Only] shielded vm initial state stored on disk

This field is a member of oneof _shielded_instance_initial_state.

Type

google.cloud.compute_v1.types.InitialStateConfig

source

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

This field is a member of oneof _source.

Type

str

type_

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Architecture(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_ARCHITECTURE (0):

A value indicating that the enum field is not set.

ARCHITECTURE_UNSPECIFIED (394750507):

Default value indicating Architecture is not set.

ARM64 (62547450):

Machines with architecture ARM64

X86_64 (425300551):

Machines with architecture X86_64

class Interface(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_INTERFACE (0):

A value indicating that the enum field is not set.

NVME (2408800):

No description available.

SCSI (2539686):

No description available.

class Mode(value)

Bases: proto.enums.Enum

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

Values:

UNDEFINED_MODE (0):

A value indicating that the enum field is not set.

READ_ONLY (91950261):

Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.

READ_WRITE (173607894):

[Default] Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.

class SavedState(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_SAVED_STATE (0):

A value indicating that the enum field is not set.

DISK_SAVED_STATE_UNSPECIFIED (391290831):

[Default] Disk state has not been preserved.

PRESERVED (254159736):

Disk state has been preserved.

class Type(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

PERSISTENT (460683927):

No description available.

SCRATCH (496778970):

No description available.

class google.cloud.compute_v1.types.AttachedDiskInitializeParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

architecture

The architecture of the attached disk. Valid values are arm64 or x86_64. Check the Architecture enum for the list of possible values.

This field is a member of oneof _architecture.

Type

str

description

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

This field is a member of oneof _description.

Type

str

disk_name

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

This field is a member of oneof _disk_name.

Type

str

disk_size_gb

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

This field is a member of oneof _disk_size_gb.

Type

int

disk_type

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

This field is a member of oneof _disk_type.

Type

str

enable_confidential_compute

Whether this disk is using confidential compute mode.

This field is a member of oneof _enable_confidential_compute.

Type

bool

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.

Type

MutableMapping[str, str]

licenses

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

Type

MutableSequence[str]

on_update_action

Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

This field is a member of oneof _on_update_action.

Type

str

provisioned_iops

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

This field is a member of oneof _provisioned_iops.

Type

int

provisioned_throughput

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.

This field is a member of oneof _provisioned_throughput.

Type

int

replica_zones

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

Type

MutableSequence[str]

resource_manager_tags

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

Type

MutableMapping[str, str]

resource_policies

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

Type

MutableSequence[str]

source_image

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

This field is a member of oneof _source_image.

Type

str

source_image_encryption_key

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

This field is a member of oneof _source_image_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_snapshot

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

This field is a member of oneof _source_snapshot.

Type

str

source_snapshot_encryption_key

The customer-supplied encryption key of the source snapshot.

This field is a member of oneof _source_snapshot_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

storage_pool

The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

This field is a member of oneof _storage_pool.

Type

str

class Architecture(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_ARCHITECTURE (0):

A value indicating that the enum field is not set.

ARCHITECTURE_UNSPECIFIED (394750507):

Default value indicating Architecture is not set.

ARM64 (62547450):

Machines with architecture ARM64

X86_64 (425300551):

Machines with architecture X86_64

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class OnUpdateAction(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_ON_UPDATE_ACTION (0):

A value indicating that the enum field is not set.

RECREATE_DISK (494767853):

Always recreate the disk.

RECREATE_DISK_IF_SOURCE_CHANGED (398099712):

Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.

USE_EXISTING_DISK (232682233):

Use the existing disk, this is the default behaviour.

class ResourceManagerTagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.AuditConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

audit_log_configs

The configuration for logging of each type of permission.

Type

MutableSequence[google.cloud.compute_v1.types.AuditLogConfig]

exempted_members

Type

MutableSequence[str]

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.

This field is a member of oneof _service.

Type

str

class google.cloud.compute_v1.types.AuditLogConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

exempted_members

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

Type

MutableSequence[str]

ignore_child_exemptions

This field is a member of oneof _ignore_child_exemptions.

Type

bool

log_type

The log type that this config enables. Check the LogType enum for the list of possible values.

This field is a member of oneof _log_type.

Type

str

class LogType(value)

Bases: proto.enums.Enum

The log type that this config enables.

Values:

UNDEFINED_LOG_TYPE (0):

A value indicating that the enum field is not set.

ADMIN_READ (128951462):

Admin reads. Example: CloudIAM getIamPolicy

DATA_READ (305224971):

Data reads. Example: CloudSQL Users list

DATA_WRITE (340181738):

Data writes. Example: CloudSQL Users create

LOG_TYPE_UNSPECIFIED (154527053):

Default case. Should never be this.

class google.cloud.compute_v1.types.Autoscaler(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

autoscaling_policy

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

This field is a member of oneof _autoscaling_policy.

Type

google.cloud.compute_v1.types.AutoscalingPolicy

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

id

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

This field is a member of oneof _id.

Type

int

kind

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

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

recommended_size

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

This field is a member of oneof _recommended_size.

Type

int

region

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

This field is a member of oneof _region.

Type

str

scaling_schedule_status

[Output Only] Status information of existing scaling schedules.

Type

MutableMapping[str, google.cloud.compute_v1.types.ScalingScheduleStatus]

self_link

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

This field is a member of oneof _self_link.

Type

str

status

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

This field is a member of oneof _status.

Type

str

status_details

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

Type

MutableSequence[google.cloud.compute_v1.types.AutoscalerStatusDetails]

target

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

This field is a member of oneof _target.

Type

str

zone

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

This field is a member of oneof _zone.

Type

str

class ScalingScheduleStatusEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Status(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

Configuration is acknowledged to be effective

DELETING (528602024):

Configuration is being deleted

ERROR (66247144):

Configuration has errors. Actionable for users.

PENDING (35394935):

Autoscaler backend hasn’t read new/updated configuration

class google.cloud.compute_v1.types.AutoscalerAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of AutoscalersScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.AutoscalersScopedList]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.AutoscalerList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of Autoscaler resources.

id

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

This field is a member of oneof _id.

Type

str

items

A list of Autoscaler resources.

Type

MutableSequence[google.cloud.compute_v1.types.Autoscaler]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.AutoscalerStatusDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

message

The status message.

This field is a member of oneof _message.

Type

str

type_

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

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

ALL_INSTANCES_UNHEALTHY (404965477):

All instances in the instance group are unhealthy (not in RUNNING state).

BACKEND_SERVICE_DOES_NOT_EXIST (191417626):

There is no backend service attached to the instance group.

CAPPED_AT_MAX_NUM_REPLICAS (518617):

Autoscaler recommends a size greater than maxNumReplicas.

CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (328964659):

The custom metric samples are not exported often enough to be a credible base for autoscaling.

CUSTOM_METRIC_INVALID (204430550):

The custom metric that was specified does not exist or does not have the necessary labels.

MIN_EQUALS_MAX (2821361):

The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.

MISSING_CUSTOM_METRIC_DATA_POINTS (94885086):

The autoscaler did not receive any data from the custom metric configured for autoscaling.

MISSING_LOAD_BALANCING_DATA_POINTS (509858898):

The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.

MODE_OFF (164169907):

Autoscaling is turned off. The number of instances in the group won’t change automatically. The autoscaling configuration is preserved.

MODE_ONLY_SCALE_OUT (3840994):

Autoscaling is in the “Autoscale only scale out” mode. Instances in the group will be only added.

MODE_ONLY_UP (100969842):

Autoscaling is in the “Autoscale only out” mode. Instances in the group will be only added.

MORE_THAN_ONE_BACKEND_SERVICE (151922141):

The instance group cannot be autoscaled because it has more than one backend service attached to it.

NOT_ENOUGH_QUOTA_AVAILABLE (403101631):

There is insufficient quota for the necessary resources, such as CPU or number of instances.

REGION_RESOURCE_STOCKOUT (528622846):

Showed only for regional autoscalers: there is a resource stockout in the chosen region.

SCALING_TARGET_DOES_NOT_EXIST (122636699):

The target to be scaled does not exist.

SCHEDULED_INSTANCES_GREATER_THAN_AUTOSCALER_MAX (29275586):

For some scaling schedules minRequiredReplicas is greater than maxNumReplicas. Autoscaler always recommends at most maxNumReplicas instances.

SCHEDULED_INSTANCES_LESS_THAN_AUTOSCALER_MIN (398287669):

For some scaling schedules minRequiredReplicas is less than minNumReplicas. Autoscaler always recommends at least minNumReplicas instances.

UNKNOWN (433141802):

No description available.

UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (330845009):

Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.

ZONE_RESOURCE_STOCKOUT (210200502):

For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you’re using there is a resource stockout.

class google.cloud.compute_v1.types.AutoscalersScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

autoscalers

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

Type

MutableSequence[google.cloud.compute_v1.types.Autoscaler]

warning

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

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.AutoscalingPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Cloud Autoscaler policy.

cool_down_period_sec

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

This field is a member of oneof _cool_down_period_sec.

Type

int

cpu_utilization

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

This field is a member of oneof _cpu_utilization.

Type

google.cloud.compute_v1.types.AutoscalingPolicyCpuUtilization

custom_metric_utilizations

Configuration parameters of autoscaling based on a custom metric.

Type

MutableSequence[google.cloud.compute_v1.types.AutoscalingPolicyCustomMetricUtilization]

load_balancing_utilization

Configuration parameters of autoscaling based on load balancer.

This field is a member of oneof _load_balancing_utilization.

Type

google.cloud.compute_v1.types.AutoscalingPolicyLoadBalancingUtilization

max_num_replicas

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

This field is a member of oneof _max_num_replicas.

Type

int

min_num_replicas

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

This field is a member of oneof _min_num_replicas.

Type

int

mode

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

This field is a member of oneof _mode.

Type

str

scale_in_control

This field is a member of oneof _scale_in_control.

Type

google.cloud.compute_v1.types.AutoscalingPolicyScaleInControl

scaling_schedules

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

Type

MutableMapping[str, google.cloud.compute_v1.types.AutoscalingPolicyScalingSchedule]

class Mode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_MODE (0):

A value indicating that the enum field is not set.

OFF (78159):

Do not automatically scale the MIG in or out. The recommended_size field contains the size of MIG that would be set if the actuation mode was enabled.

ON (2527):

Automatically scale the MIG in and out according to the policy.

ONLY_SCALE_OUT (152713670):

Automatically create VMs according to the policy, but do not scale the MIG in.

ONLY_UP (478095374):

Automatically create VMs according to the policy, but do not scale the MIG in.

class ScalingSchedulesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.AutoscalingPolicyCpuUtilization(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

CPU utilization policy.

predictive_method

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

This field is a member of oneof _predictive_method.

Type

str

utilization_target

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

This field is a member of oneof _utilization_target.

Type

float

class PredictiveMethod(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_PREDICTIVE_METHOD (0):

A value indicating that the enum field is not set.

NONE (2402104):

No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics

OPTIMIZE_AVAILABILITY (11629437):

Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.

class google.cloud.compute_v1.types.AutoscalingPolicyCustomMetricUtilization(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Custom utilization metric policy.

filter

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

This field is a member of oneof _filter.

Type

str

metric

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

This field is a member of oneof _metric.

Type

str

single_instance_assignment

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

This field is a member of oneof _single_instance_assignment.

Type

float

utilization_target

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

This field is a member of oneof _utilization_target.

Type

float

utilization_target_type

Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. Check the UtilizationTargetType enum for the list of possible values.

This field is a member of oneof _utilization_target_type.

Type

str

class UtilizationTargetType(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_UTILIZATION_TARGET_TYPE (0):

A value indicating that the enum field is not set.

DELTA_PER_MINUTE (87432861):

Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per minute.

DELTA_PER_SECOND (255180029):

Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per second.

GAUGE (67590361):

Sets the utilization target value for a gauge metric. The autoscaler will collect the average utilization of the virtual machines from the last couple of minutes, and compare the value to the utilization target value to perform autoscaling.

class google.cloud.compute_v1.types.AutoscalingPolicyLoadBalancingUtilization(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration parameters of autoscaling based on load balancing.

utilization_target

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

This field is a member of oneof _utilization_target.

Type

float

class google.cloud.compute_v1.types.AutoscalingPolicyScaleInControl(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

max_scaled_in_replicas

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

This field is a member of oneof _max_scaled_in_replicas.

Type

google.cloud.compute_v1.types.FixedOrPercent

time_window_sec

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

This field is a member of oneof _time_window_sec.

Type

int

class google.cloud.compute_v1.types.AutoscalingPolicyScalingSchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

description

A description of a scaling schedule.

This field is a member of oneof _description.

Type

str

disabled

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

This field is a member of oneof _disabled.

Type

bool

duration_sec

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

This field is a member of oneof _duration_sec.

Type

int

min_required_replicas

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

This field is a member of oneof _min_required_replicas.

Type

int

schedule

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

This field is a member of oneof _schedule.

Type

str

time_zone

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

This field is a member of oneof _time_zone.

Type

str

class google.cloud.compute_v1.types.Backend(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Message containing information of one individual backend.

balancing_mode

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

This field is a member of oneof _balancing_mode.

Type

str

capacity_scaler

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

This field is a member of oneof _capacity_scaler.

Type

float

description

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

This field is a member of oneof _description.

Type

str

failover

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

This field is a member of oneof _failover.

Type

bool

group

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

This field is a member of oneof _group.

Type

str

max_connections

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

This field is a member of oneof _max_connections.

Type

int

max_connections_per_endpoint

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

This field is a member of oneof _max_connections_per_endpoint.

Type

int

max_connections_per_instance

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

This field is a member of oneof _max_connections_per_instance.

Type

int

max_rate

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

This field is a member of oneof _max_rate.

Type

int

max_rate_per_endpoint

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

This field is a member of oneof _max_rate_per_endpoint.

Type

float

max_rate_per_instance

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

This field is a member of oneof _max_rate_per_instance.

Type

float

max_utilization

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

This field is a member of oneof _max_utilization.

Type

float

preference

This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don’t have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default Check the Preference enum for the list of possible values.

This field is a member of oneof _preference.

Type

str

class BalancingMode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_BALANCING_MODE (0):

A value indicating that the enum field is not set.

CONNECTION (246311646):

Balance based on the number of simultaneous connections.

RATE (2508000):

Balance based on requests per second (RPS).

UTILIZATION (157008386):

Balance based on the backend utilization.

class Preference(value)

Bases: proto.enums.Enum

This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don’t have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default

Values:

UNDEFINED_PREFERENCE (0):

A value indicating that the enum field is not set.

DEFAULT (115302945):

No preference.

PREFERENCE_UNSPECIFIED (496219571):

If preference is unspecified, we set it to the DEFAULT value

PREFERRED (418847841):

Traffic will be sent to this backend first.

class google.cloud.compute_v1.types.BackendBucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

bucket_name

Cloud Storage bucket name.

This field is a member of oneof _bucket_name.

Type

str

cdn_policy

Cloud CDN configuration for this BackendBucket.

This field is a member of oneof _cdn_policy.

Type

google.cloud.compute_v1.types.BackendBucketCdnPolicy

compression_mode

Compress text responses using Brotli or gzip compression, based on the client’s Accept-Encoding header. Check the CompressionMode enum for the list of possible values.

This field is a member of oneof _compression_mode.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

custom_response_headers

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

Type

MutableSequence[str]

description

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

This field is a member of oneof _description.

Type

str

edge_security_policy

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

This field is a member of oneof _edge_security_policy.

Type

str

enable_cdn

If true, enable Cloud CDN for this BackendBucket.

This field is a member of oneof _enable_cdn.

Type

bool

id

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

This field is a member of oneof _id.

Type

int

kind

Type of the resource.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

used_by

[Output Only] List of resources referencing that backend bucket.

Type

MutableSequence[google.cloud.compute_v1.types.BackendBucketUsedBy]

class CompressionMode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_COMPRESSION_MODE (0):

A value indicating that the enum field is not set.

AUTOMATIC (165298699):

Automatically uses the best compression based on the Accept-Encoding header sent by the client.

DISABLED (516696700):

Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.

class google.cloud.compute_v1.types.BackendBucketCdnPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Message containing Cloud CDN configuration for a backend bucket.

bypass_cache_on_request_headers

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

Type

MutableSequence[google.cloud.compute_v1.types.BackendBucketCdnPolicyBypassCacheOnRequestHeader]

cache_key_policy

The CacheKeyPolicy for this CdnPolicy.

This field is a member of oneof _cache_key_policy.

Type

google.cloud.compute_v1.types.BackendBucketCdnPolicyCacheKeyPolicy

cache_mode

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

This field is a member of oneof _cache_mode.

Type

str

client_ttl

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

This field is a member of oneof _client_ttl.

Type

int

default_ttl

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

This field is a member of oneof _default_ttl.

Type

int

max_ttl

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

This field is a member of oneof _max_ttl.

Type

int

negative_caching

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

This field is a member of oneof _negative_caching.

Type

bool

negative_caching_policy

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

Type

MutableSequence[google.cloud.compute_v1.types.BackendBucketCdnPolicyNegativeCachingPolicy]

request_coalescing

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

This field is a member of oneof _request_coalescing.

Type

bool

serve_while_stale

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

This field is a member of oneof _serve_while_stale.

Type

int

signed_url_cache_max_age_sec

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.

This field is a member of oneof _signed_url_cache_max_age_sec.

Type

int

signed_url_key_names

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

Type

MutableSequence[str]

class CacheMode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_CACHE_MODE (0):

A value indicating that the enum field is not set.

CACHE_ALL_STATIC (355027945):

Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

FORCE_CACHE_ALL (486026928):

Cache all content, ignoring any “private”, “no-store” or “no-cache” directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.

INVALID_CACHE_MODE (381295560):

No description available.

USE_ORIGIN_HEADERS (55380261):

Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google’s edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.

class google.cloud.compute_v1.types.BackendBucketCdnPolicyBypassCacheOnRequestHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

header_name

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

This field is a member of oneof _header_name.

Type

str

class google.cloud.compute_v1.types.BackendBucketCdnPolicyCacheKeyPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

include_http_headers

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

Type

MutableSequence[str]

query_string_whitelist

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

Type

MutableSequence[str]

class google.cloud.compute_v1.types.BackendBucketCdnPolicyNegativeCachingPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specify CDN TTLs for response error codes.

code

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

This field is a member of oneof _code.

Type

int

ttl

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

This field is a member of oneof _ttl.

Type

int

class google.cloud.compute_v1.types.BackendBucketList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of BackendBucket resources.

id

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

This field is a member of oneof _id.

Type

str

items

A list of BackendBucket resources.

Type

MutableSequence[google.cloud.compute_v1.types.BackendBucket]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.BackendBucketUsedBy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

reference

[Output Only] Server-defined URL for UrlMaps referencing that BackendBucket.

This field is a member of oneof _reference.

Type

str

class google.cloud.compute_v1.types.BackendService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

affinity_cookie_ttl_sec

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

This field is a member of oneof _affinity_cookie_ttl_sec.

Type

int

backends

The list of backends that serve this BackendService.

Type

MutableSequence[google.cloud.compute_v1.types.Backend]

cdn_policy

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

This field is a member of oneof _cdn_policy.

Type

google.cloud.compute_v1.types.BackendServiceCdnPolicy

circuit_breakers

This field is a member of oneof _circuit_breakers.

Type

google.cloud.compute_v1.types.CircuitBreakers

compression_mode

Compress text responses using Brotli or gzip compression, based on the client’s Accept-Encoding header. Check the CompressionMode enum for the list of possible values.

This field is a member of oneof _compression_mode.

Type

str

connection_draining

This field is a member of oneof _connection_draining.

Type

google.cloud.compute_v1.types.ConnectionDraining

connection_tracking_policy

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers.

This field is a member of oneof _connection_tracking_policy.

Type

google.cloud.compute_v1.types.BackendServiceConnectionTrackingPolicy

consistent_hash

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

This field is a member of oneof _consistent_hash.

Type

google.cloud.compute_v1.types.ConsistentHashLoadBalancerSettings

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

custom_request_headers

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

Type

MutableSequence[str]

custom_response_headers

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

Type

MutableSequence[str]

description

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

This field is a member of oneof _description.

Type

str

edge_security_policy

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

This field is a member of oneof _edge_security_policy.

Type

str

enable_c_d_n

If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.

This field is a member of oneof _enable_c_d_n.

Type

bool

failover_policy

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

This field is a member of oneof _failover_policy.

Type

google.cloud.compute_v1.types.BackendServiceFailoverPolicy

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. To see the latest fingerprint, make a get() request to retrieve a BackendService.

This field is a member of oneof _fingerprint.

Type

str

health_checks

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

Type

MutableSequence[str]

iap

The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.

This field is a member of oneof _iap.

Type

google.cloud.compute_v1.types.BackendServiceIAP

id

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

This field is a member of oneof _id.

Type

int

ip_address_selection_policy

Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint’s IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). Check the IpAddressSelectionPolicy enum for the list of possible values.

This field is a member of oneof _ip_address_selection_policy.

Type

str

kind

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

This field is a member of oneof _kind.

Type

str

load_balancing_scheme

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

This field is a member of oneof _load_balancing_scheme.

Type

str

locality_lb_policies

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

Type

MutableSequence[google.cloud.compute_v1.types.BackendServiceLocalityLoadBalancingPolicyConfig]

locality_lb_policy

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

This field is a member of oneof _locality_lb_policy.

Type

str

log_config

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

This field is a member of oneof _log_config.

Type

google.cloud.compute_v1.types.BackendServiceLogConfig

max_stream_duration

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

This field is a member of oneof _max_stream_duration.

Type

google.cloud.compute_v1.types.Duration

metadatas

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

Type

MutableMapping[str, str]

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.

This field is a member of oneof _name.

Type

str

network

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

This field is a member of oneof _network.

Type

str

outlier_detection

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

This field is a member of oneof _outlier_detection.

Type

google.cloud.compute_v1.types.OutlierDetection

port

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port.

This field is a member of oneof _port.

Type

int

port_name

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

This field is a member of oneof _port_name.

Type

str

protocol

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

This field is a member of oneof _protocol.

Type

str

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.

This field is a member of oneof _region.

Type

str

security_policy

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

This field is a member of oneof _security_policy.

Type

str

security_settings

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

This field is a member of oneof _security_settings.

Type

google.cloud.compute_v1.types.SecuritySettings

self_link

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

This field is a member of oneof _self_link.

Type

str

service_bindings

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

Type

MutableSequence[str]

service_lb_policy

URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.

This field is a member of oneof _service_lb_policy.

Type

str

session_affinity

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

This field is a member of oneof _session_affinity.

Type

str

strong_session_affinity_cookie

Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.

This field is a member of oneof _strong_session_affinity_cookie.

Type

google.cloud.compute_v1.types.BackendServiceHttpCookie

subsetting

This field is a member of oneof _subsetting.

Type

google.cloud.compute_v1.types.Subsetting

timeout_sec

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

This field is a member of oneof _timeout_sec.

Type

int

used_by

[Output Only] List of resources referencing given backend service.

Type

MutableSequence[google.cloud.compute_v1.types.BackendServiceUsedBy]

class CompressionMode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_COMPRESSION_MODE (0):

A value indicating that the enum field is not set.

AUTOMATIC (165298699):

Automatically uses the best compression based on the Accept-Encoding header sent by the client.

DISABLED (516696700):

Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.

class IpAddressSelectionPolicy(value)

Bases: proto.enums.Enum

Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint’s IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).

Values:

UNDEFINED_IP_ADDRESS_SELECTION_POLICY (0):

A value indicating that the enum field is not set.

IPV4_ONLY (22373798):

Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting.

IPV6_ONLY (79632100):

Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends.

IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED (36210144):

Unspecified IP address selection policy.

PREFER_IPV6 (408601302):

Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).

class LoadBalancingScheme(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_LOAD_BALANCING_SCHEME (0):

A value indicating that the enum field is not set.

EXTERNAL (35607499):

Signifies that this will be used for classic Application Load Balancers, global external proxy Network Load Balancers, or external passthrough Network Load Balancers.

EXTERNAL_MANAGED (512006923):

Signifies that this will be used for global external Application Load Balancers, regional external Application Load Balancers, or regional external proxy Network Load Balancers.

INTERNAL (279295677):

Signifies that this will be used for internal passthrough Network Load Balancers.

INTERNAL_MANAGED (37350397):

Signifies that this will be used for internal Application Load Balancers.

INTERNAL_SELF_MANAGED (236211150):

Signifies that this will be used by Traffic Director.

INVALID_LOAD_BALANCING_SCHEME (275352060):

No description available.

class LocalityLbPolicy(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_LOCALITY_LB_POLICY (0):

A value indicating that the enum field is not set.

INVALID_LB_POLICY (323318707):

No description available.

LEAST_REQUEST (46604921):

An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

MAGLEV (119180266):

This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824

ORIGINAL_DESTINATION (166297216):

Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

RANDOM (262527171):

The load balancer selects a random healthy host.

RING_HASH (432795069):

The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

ROUND_ROBIN (153895801):

This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

WEIGHTED_MAGLEV (254930962):

Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.

class MetadatasEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Protocol(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_PROTOCOL (0):

A value indicating that the enum field is not set.

GRPC (2196510):

gRPC (available for Traffic Director).

HTTP (2228360):

No description available.

HTTP2 (69079210):

HTTP/2 with SSL.

HTTPS (69079243):

No description available.

SSL (82412):

TCP proxying with SSL.

TCP (82881):

TCP proxying or TCP pass-through.

UDP (83873):

UDP.

UNSPECIFIED (526786327):

If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.

class SessionAffinity(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_SESSION_AFFINITY (0):

A value indicating that the enum field is not set.

CLIENT_IP (345665051):

2-tuple hash on packet’s source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.

CLIENT_IP_NO_DESTINATION (106122516):

1-tuple hash only on packet’s source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.

CLIENT_IP_PORT_PROTO (221722926):

5-tuple hash on packet’s source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.

CLIENT_IP_PROTO (25322148):

3-tuple hash on packet’s source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.

GENERATED_COOKIE (370321204):

Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.

HEADER_FIELD (200737960):

The hash is based on a user specified header field.

HTTP_COOKIE (494981627):

The hash is based on a user provided cookie.

NONE (2402104):

No session affinity. Connections from the same client IP may go to any instance in the pool.

STRONG_COOKIE_AFFINITY (438628091):

Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired.

class google.cloud.compute_v1.types.BackendServiceAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of BackendServicesScopedList.

id

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

This field is a member of oneof _id.

Type

str

items

A list of BackendServicesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.BackendServicesScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.BackendServiceCdnPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Message containing Cloud CDN configuration for a backend service.

bypass_cache_on_request_headers

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

Type

MutableSequence[google.cloud.compute_v1.types.BackendServiceCdnPolicyBypassCacheOnRequestHeader]

cache_key_policy

The CacheKeyPolicy for this CdnPolicy.

This field is a member of oneof _cache_key_policy.

Type

google.cloud.compute_v1.types.CacheKeyPolicy

cache_mode

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

This field is a member of oneof _cache_mode.

Type

str

client_ttl

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

This field is a member of oneof _client_ttl.

Type

int

default_ttl

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

This field is a member of oneof _default_ttl.

Type

int

max_ttl

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

This field is a member of oneof _max_ttl.

Type

int

negative_caching

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

This field is a member of oneof _negative_caching.

Type

bool

negative_caching_policy

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

Type

MutableSequence[google.cloud.compute_v1.types.BackendServiceCdnPolicyNegativeCachingPolicy]

request_coalescing

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

This field is a member of oneof _request_coalescing.

Type

bool

serve_while_stale

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

This field is a member of oneof _serve_while_stale.

Type

int

signed_url_cache_max_age_sec

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.

This field is a member of oneof _signed_url_cache_max_age_sec.

Type

int

signed_url_key_names

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

Type

MutableSequence[str]

class CacheMode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_CACHE_MODE (0):

A value indicating that the enum field is not set.

CACHE_ALL_STATIC (355027945):

Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

FORCE_CACHE_ALL (486026928):

Cache all content, ignoring any “private”, “no-store” or “no-cache” directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.

INVALID_CACHE_MODE (381295560):

No description available.

USE_ORIGIN_HEADERS (55380261):

Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google’s edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.

class google.cloud.compute_v1.types.BackendServiceCdnPolicyBypassCacheOnRequestHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

header_name

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

This field is a member of oneof _header_name.

Type

str

class google.cloud.compute_v1.types.BackendServiceCdnPolicyNegativeCachingPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specify CDN TTLs for response error codes.

code

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

This field is a member of oneof _code.

Type

int

ttl

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

This field is a member of oneof _ttl.

Type

int

class google.cloud.compute_v1.types.BackendServiceConnectionTrackingPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Connection Tracking configuration for this BackendService.

connection_persistence_on_unhealthy_backends

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

This field is a member of oneof _connection_persistence_on_unhealthy_backends.

Type

str

enable_strong_affinity

Enable Strong Session Affinity for external passthrough Network Load Balancers. This option is not available publicly.

This field is a member of oneof _enable_strong_affinity.

Type

bool

idle_timeout_sec

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

This field is a member of oneof _idle_timeout_sec.

Type

int

tracking_mode

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

This field is a member of oneof _tracking_mode.

Type

str

class ConnectionPersistenceOnUnhealthyBackends(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_CONNECTION_PERSISTENCE_ON_UNHEALTHY_BACKENDS (0):

A value indicating that the enum field is not set.

ALWAYS_PERSIST (38400900):

No description available.

DEFAULT_FOR_PROTOCOL (145265356):

No description available.

NEVER_PERSIST (138646241):

No description available.

class TrackingMode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_TRACKING_MODE (0):

A value indicating that the enum field is not set.

INVALID_TRACKING_MODE (49234371):

No description available.

PER_CONNECTION (85162848):

No description available.

PER_SESSION (182099252):

No description available.

class google.cloud.compute_v1.types.BackendServiceFailoverPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

disable_connection_drain_on_failover

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

This field is a member of oneof _disable_connection_drain_on_failover.

Type

bool

drop_traffic_if_unhealthy

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

This field is a member of oneof _drop_traffic_if_unhealthy.

Type

bool

failover_ratio

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

This field is a member of oneof _failover_ratio.

Type

float

class google.cloud.compute_v1.types.BackendServiceGroupHealth(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

annotations

Metadata defined as annotations on the network endpoint group.

Type

MutableMapping[str, str]

health_status

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

Type

MutableSequence[google.cloud.compute_v1.types.HealthStatus]

kind

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

This field is a member of oneof _kind.

Type

str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.BackendServiceHttpCookie(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The HTTP cookie used for stateful session affinity.

name

Name of the cookie.

This field is a member of oneof _name.

Type

str

path

Path to set for the cookie.

This field is a member of oneof _path.

Type

str

ttl

Lifetime of the cookie.

This field is a member of oneof _ttl.

Type

google.cloud.compute_v1.types.Duration

class google.cloud.compute_v1.types.BackendServiceIAP(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Identity-Aware Proxy

enabled

Whether the serving infrastructure will authenticate and authorize all incoming requests.

This field is a member of oneof _enabled.

Type

bool

oauth2_client_id

OAuth2 client ID to use for the authentication flow.

This field is a member of oneof _oauth2_client_id.

Type

str

oauth2_client_secret

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

This field is a member of oneof _oauth2_client_secret.

Type

str

oauth2_client_secret_sha256

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

This field is a member of oneof _oauth2_client_secret_sha256.

Type

str

class google.cloud.compute_v1.types.BackendServiceList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of BackendService resources.

id

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

This field is a member of oneof _id.

Type

str

items

A list of BackendService resources.

Type

MutableSequence[google.cloud.compute_v1.types.BackendService]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.BackendServiceListUsable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of usable BackendService resources.

id

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

This field is a member of oneof _id.

Type

str

items

A list of BackendService resources.

Type

MutableSequence[google.cloud.compute_v1.types.BackendService]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.BackendServiceLocalityLoadBalancingPolicyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

custom_policy

This field is a member of oneof _custom_policy.

Type

google.cloud.compute_v1.types.BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy

policy

This field is a member of oneof _policy.

Type

google.cloud.compute_v1.types.BackendServiceLocalityLoadBalancingPolicyConfigPolicy

class google.cloud.compute_v1.types.BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

data

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

This field is a member of oneof _data.

Type

str

name

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

This field is a member of oneof _name.

Type

str

class google.cloud.compute_v1.types.BackendServiceLocalityLoadBalancingPolicyConfigPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The configuration for a built-in load balancing policy.

name

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

This field is a member of oneof _name.

Type

str

class Name(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_NAME (0):

A value indicating that the enum field is not set.

INVALID_LB_POLICY (323318707):

No description available.

LEAST_REQUEST (46604921):

An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

MAGLEV (119180266):

This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824

ORIGINAL_DESTINATION (166297216):

Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

RANDOM (262527171):

The load balancer selects a random healthy host.

RING_HASH (432795069):

The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

ROUND_ROBIN (153895801):

This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

WEIGHTED_MAGLEV (254930962):

Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.

class google.cloud.compute_v1.types.BackendServiceLogConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

enable

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

This field is a member of oneof _enable.

Type

bool

optional_fields

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

Type

MutableSequence[str]

optional_mode

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

This field is a member of oneof _optional_mode.

Type

str

sample_rate

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

This field is a member of oneof _sample_rate.

Type

float

class OptionalMode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_OPTIONAL_MODE (0):

A value indicating that the enum field is not set.

CUSTOM (388595569):

A subset of optional fields.

EXCLUDE_ALL_OPTIONAL (168636099):

None optional fields.

INCLUDE_ALL_OPTIONAL (535606965):

All optional fields.

class google.cloud.compute_v1.types.BackendServiceReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

backend_service

This field is a member of oneof _backend_service.

Type

str

class google.cloud.compute_v1.types.BackendServiceUsedBy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

reference

[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.

This field is a member of oneof _reference.

Type

str

class google.cloud.compute_v1.types.BackendServicesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

backend_services

A list of BackendServices contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.BackendService]

warning

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

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.BfdPacket(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

authentication_present

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

This field is a member of oneof _authentication_present.

Type

bool

control_plane_independent

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

This field is a member of oneof _control_plane_independent.

Type

bool

demand

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

This field is a member of oneof _demand.

Type

bool

diagnostic

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

This field is a member of oneof _diagnostic.

Type

str

final

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

This field is a member of oneof _final.

Type

bool

length

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

This field is a member of oneof _length.

Type

int

min_echo_rx_interval_ms

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

This field is a member of oneof _min_echo_rx_interval_ms.

Type

int

min_rx_interval_ms

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

This field is a member of oneof _min_rx_interval_ms.

Type

int

min_tx_interval_ms

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

This field is a member of oneof _min_tx_interval_ms.

Type

int

multiplier

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

This field is a member of oneof _multiplier.

Type

int

multipoint

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

This field is a member of oneof _multipoint.

Type

bool

my_discriminator

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

This field is a member of oneof _my_discriminator.

Type

int

poll

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

This field is a member of oneof _poll.

Type

bool

state

The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

version

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

This field is a member of oneof _version.

Type

int

your_discriminator

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

This field is a member of oneof _your_discriminator.

Type

int

class Diagnostic(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_DIAGNOSTIC (0):

A value indicating that the enum field is not set.

ADMINISTRATIVELY_DOWN (121685798):

No description available.

CONCATENATED_PATH_DOWN (26186892):

No description available.

CONTROL_DETECTION_TIME_EXPIRED (135478383):

No description available.

DIAGNOSTIC_UNSPECIFIED (58720895):

No description available.

ECHO_FUNCTION_FAILED (220687466):

No description available.

FORWARDING_PLANE_RESET (19715882):

No description available.

NEIGHBOR_SIGNALED_SESSION_DOWN (374226742):

No description available.

NO_DIAGNOSTIC (222503141):

No description available.

PATH_DOWN (290605180):

No description available.

REVERSE_CONCATENATED_PATH_DOWN (479337129):

No description available.

class State(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ADMIN_DOWN (128544690):

No description available.

DOWN (2104482):

No description available.

INIT (2252048):

No description available.

STATE_UNSPECIFIED (470755401):

No description available.

UP (2715):

No description available.

class google.cloud.compute_v1.types.BfdStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Next free: 15

bfd_session_initialization_mode

The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. Check the BfdSessionInitializationMode enum for the list of possible values.

This field is a member of oneof _bfd_session_initialization_mode.

Type

str

config_update_timestamp_micros

Unix timestamp of the most recent config update.

This field is a member of oneof _config_update_timestamp_micros.

Type

int

control_packet_counts

Control packet counts for the current BFD session.

This field is a member of oneof _control_packet_counts.

Type

google.cloud.compute_v1.types.BfdStatusPacketCounts

control_packet_intervals

Inter-packet time interval statistics for control packets.

Type

MutableSequence[google.cloud.compute_v1.types.PacketIntervals]

local_diagnostic

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

This field is a member of oneof _local_diagnostic.

Type

str

local_state

The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 Check the LocalState enum for the list of possible values.

This field is a member of oneof _local_state.

Type

str

negotiated_local_control_tx_interval_ms

Negotiated transmit interval for control packets.

This field is a member of oneof _negotiated_local_control_tx_interval_ms.

Type

int

rx_packet

The most recent Rx control packet for this BFD session.

This field is a member of oneof _rx_packet.

Type

google.cloud.compute_v1.types.BfdPacket

tx_packet

The most recent Tx control packet for this BFD session.

This field is a member of oneof _tx_packet.

Type

google.cloud.compute_v1.types.BfdPacket

uptime_ms

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

This field is a member of oneof _uptime_ms.

Type

int

class BfdSessionInitializationMode(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_BFD_SESSION_INITIALIZATION_MODE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

No description available.

DISABLED (516696700):

No description available.

PASSIVE (462813959):

No description available.

class LocalDiagnostic(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_LOCAL_DIAGNOSTIC (0):

A value indicating that the enum field is not set.

ADMINISTRATIVELY_DOWN (121685798):

No description available.

CONCATENATED_PATH_DOWN (26186892):

No description available.

CONTROL_DETECTION_TIME_EXPIRED (135478383):

No description available.

DIAGNOSTIC_UNSPECIFIED (58720895):

No description available.

ECHO_FUNCTION_FAILED (220687466):

No description available.

FORWARDING_PLANE_RESET (19715882):

No description available.

NEIGHBOR_SIGNALED_SESSION_DOWN (374226742):

No description available.

NO_DIAGNOSTIC (222503141):

No description available.

PATH_DOWN (290605180):

No description available.

REVERSE_CONCATENATED_PATH_DOWN (479337129):

No description available.

class LocalState(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_LOCAL_STATE (0):

A value indicating that the enum field is not set.

ADMIN_DOWN (128544690):

No description available.

DOWN (2104482):

No description available.

INIT (2252048):

No description available.

STATE_UNSPECIFIED (470755401):

No description available.

UP (2715):

No description available.

class google.cloud.compute_v1.types.BfdStatusPacketCounts(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

num_rx

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

This field is a member of oneof _num_rx.

Type

int

num_rx_rejected

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

This field is a member of oneof _num_rx_rejected.

Type

int

num_rx_successful

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

This field is a member of oneof _num_rx_successful.

Type

int

num_tx

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

This field is a member of oneof _num_tx.

Type

int

class google.cloud.compute_v1.types.Binding(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Associates members, or principals, with a role.

binding_id

This field is a member of oneof _binding_id.

Type

str

condition

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

This field is a member of oneof _condition.

Type

google.cloud.compute_v1.types.Expr

members

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

Type

MutableSequence[str]

role

Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. For an overview of the IAM roles and permissions, see the IAM documentation. For a list of the available pre-defined roles, see here.

This field is a member of oneof _role.

Type

str

class google.cloud.compute_v1.types.BulkInsertDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.BulkInsert. See the method description for details.

bulk_insert_disk_resource_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BulkInsertDiskResource

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.BulkInsertDiskResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

source_consistency_group_policy

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

This field is a member of oneof _source_consistency_group_policy.

Type

str

class google.cloud.compute_v1.types.BulkInsertInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.BulkInsert. See the method description for details.

bulk_insert_instance_resource_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BulkInsertInstanceResource

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.BulkInsertInstanceResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

count

The maximum number of instances to create.

This field is a member of oneof _count.

Type

int

instance_properties

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

This field is a member of oneof _instance_properties.

Type

google.cloud.compute_v1.types.InstanceProperties

location_policy

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

This field is a member of oneof _location_policy.

Type

google.cloud.compute_v1.types.LocationPolicy

min_count

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

This field is a member of oneof _min_count.

Type

int

name_pattern

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

This field is a member of oneof _name_pattern.

Type

str

per_instance_properties

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

Type

MutableMapping[str, google.cloud.compute_v1.types.BulkInsertInstanceResourcePerInstanceProperties]

source_instance_template

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

This field is a member of oneof _source_instance_template.

Type

str

class PerInstancePropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.BulkInsertInstanceResourcePerInstanceProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

hostname

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

This field is a member of oneof _hostname.

Type

str

name

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

This field is a member of oneof _name.

Type

str

class google.cloud.compute_v1.types.BulkInsertOperationStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

created_vm_count

[Output Only] Count of VMs successfully created so far.

This field is a member of oneof _created_vm_count.

Type

int

deleted_vm_count

[Output Only] Count of VMs that got deleted during rollback.

This field is a member of oneof _deleted_vm_count.

Type

int

failed_to_create_vm_count

[Output Only] Count of VMs that started creating but encountered an error.

This field is a member of oneof _failed_to_create_vm_count.

Type

int

status

[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

target_vm_count

[Output Only] Count of VMs originally planned to be created.

This field is a member of oneof _target_vm_count.

Type

int

class Status(value)

Bases: proto.enums.Enum

[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

Rolling forward - creating VMs.

DONE (2104194):

Done

ROLLING_BACK (259411649):

Rolling back - cleaning up after an error.

STATUS_UNSPECIFIED (42133066):

No description available.

class google.cloud.compute_v1.types.BulkInsertRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.BulkInsert. See the method description for details.

bulk_insert_disk_resource_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BulkInsertDiskResource

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.BulkInsertRegionInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstances.BulkInsert. See the method description for details.

bulk_insert_instance_resource_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BulkInsertInstanceResource

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.CacheInvalidationRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

host

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

This field is a member of oneof _host.

Type

str

path

This field is a member of oneof _path.

Type

str

class google.cloud.compute_v1.types.CacheKeyPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

include_host

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

This field is a member of oneof _include_host.

Type

bool

include_http_headers

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

Type

MutableSequence[str]

include_named_cookies

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

Type

MutableSequence[str]

include_protocol

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

This field is a member of oneof _include_protocol.

Type

bool

include_query_string

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.

This field is a member of oneof _include_query_string.

Type

bool

query_string_blacklist

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

Type

MutableSequence[str]

query_string_whitelist

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

Type

MutableSequence[str]

class google.cloud.compute_v1.types.CancelInstanceGroupManagerResizeRequestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagerResizeRequests.Cancel. See the method description for details.

instance_group_manager

The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

resize_request

The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID.

Type

str

zone

The name of the zone where the managed instance group is located. The name should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.CircuitBreakers(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

max_connections

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

This field is a member of oneof _max_connections.

Type

int

max_pending_requests

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

This field is a member of oneof _max_pending_requests.

Type

int

max_requests

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

This field is a member of oneof _max_requests.

Type

int

max_requests_per_connection

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

This field is a member of oneof _max_requests_per_connection.

Type

int

max_retries

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

This field is a member of oneof _max_retries.

Type

int

class google.cloud.compute_v1.types.CloneRulesFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.CloneRules. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

source_firewall_policy

The firewall policy from which to copy rules.

This field is a member of oneof _source_firewall_policy.

Type

str

class google.cloud.compute_v1.types.CloneRulesNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.CloneRules. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

source_firewall_policy

The firewall policy from which to copy rules.

This field is a member of oneof _source_firewall_policy.

Type

str

class google.cloud.compute_v1.types.CloneRulesRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.CloneRules. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

source_firewall_policy

The firewall policy from which to copy rules.

This field is a member of oneof _source_firewall_policy.

Type

str

class google.cloud.compute_v1.types.Commitment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

auto_renew

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

This field is a member of oneof _auto_renew.

Type

bool

category

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

This field is a member of oneof _category.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

custom_end_timestamp

[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD’s end date is later than the start date + term duration.

This field is a member of oneof _custom_end_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

end_timestamp

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

This field is a member of oneof _end_timestamp.

Type

str

existing_reservations

Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation

Type

MutableSequence[str]

id

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

This field is a member of oneof _id.

Type

int

kind

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

This field is a member of oneof _kind.

Type

str

license_resource

The license specification required as part of a license commitment.

This field is a member of oneof _license_resource.

Type

google.cloud.compute_v1.types.LicenseResourceCommitment

merge_source_commitments

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

Type

MutableSequence[str]

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.

This field is a member of oneof _name.

Type

str

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). Check the Plan enum for the list of possible values.

This field is a member of oneof _plan.

Type

str

region

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

This field is a member of oneof _region.

Type

str

reservations

List of create-on-create reservations for this commitment.

Type

MutableSequence[google.cloud.compute_v1.types.Reservation]

resource_status

[Output Only] Status information for Commitment resource.

This field is a member of oneof _resource_status.

Type

google.cloud.compute_v1.types.CommitmentResourceStatus

resources

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

Type

MutableSequence[google.cloud.compute_v1.types.ResourceCommitment]

self_link

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

This field is a member of oneof _self_link.

Type

str

split_source_commitment

Source commitment to be split into a new commitment.

This field is a member of oneof _split_source_commitment.

Type

str

start_timestamp

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

This field is a member of oneof _start_timestamp.

Type

str

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. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

status_message

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

This field is a member of oneof _status_message.

Type

str

type_

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

This field is a member of oneof _type.

Type

str

class Category(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_CATEGORY (0):

A value indicating that the enum field is not set.

CATEGORY_UNSPECIFIED (509189462):

No description available.

LICENSE (347869217):

No description available.

MACHINE (469553191):

No description available.

class Plan(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_PLAN (0):

A value indicating that the enum field is not set.

INVALID (530283991):

No description available.

THIRTY_SIX_MONTH (266295942):

No description available.

TWELVE_MONTH (173083962):

No description available.

class Status(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

No description available.

CANCELLED (41957681):

Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.

CREATING (455564985):

No description available.

EXPIRED (482489093):

No description available.

NOT_YET_ACTIVE (20607337):

No description available.

class Type(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

ACCELERATOR_OPTIMIZED (280848403):

No description available.

ACCELERATOR_OPTIMIZED_A3 (158574526):

No description available.

ACCELERATOR_OPTIMIZED_A3_MEGA (156517459):

No description available.

COMPUTE_OPTIMIZED (158349023):

No description available.

COMPUTE_OPTIMIZED_C2D (383246453):

No description available.

COMPUTE_OPTIMIZED_C3 (428004784):

No description available.

COMPUTE_OPTIMIZED_C3D (383246484):

No description available.

COMPUTE_OPTIMIZED_H3 (428004939):

No description available.

GENERAL_PURPOSE (299793543):

No description available.

GENERAL_PURPOSE_C4 (301911817):

No description available.

GENERAL_PURPOSE_C4A (232460888):

No description available.

GENERAL_PURPOSE_E2 (301911877):

No description available.

GENERAL_PURPOSE_N2 (301912156):

No description available.

GENERAL_PURPOSE_N2D (232471400):

No description available.

GENERAL_PURPOSE_N4 (301912158):

No description available.

GENERAL_PURPOSE_T2D (232477166):

No description available.

GRAPHICS_OPTIMIZED (68500563):

No description available.

MEMORY_OPTIMIZED (281753417):

No description available.

MEMORY_OPTIMIZED_M3 (276301372):

No description available.

STORAGE_OPTIMIZED_Z3 (316796085):

No description available.

TYPE_UNSPECIFIED (437714322):

No description available.

class google.cloud.compute_v1.types.CommitmentAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of CommitmentsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.CommitmentsScopedList]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.CommitmentList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of Commitment resources.

id

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

This field is a member of oneof _id.

Type

str

items

A list of Commitment resources.

Type

MutableSequence[google.cloud.compute_v1.types.Commitment]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.CommitmentResourceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] Contains output only fields.

custom_term_eligibility_end_timestamp

[Output Only] Indicates the end time of customer’s eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.

This field is a member of oneof _custom_term_eligibility_end_timestamp.

Type

str

class google.cloud.compute_v1.types.CommitmentsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

commitments

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

Type

MutableSequence[google.cloud.compute_v1.types.Commitment]

warning

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

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ConfidentialInstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A set of Confidential Instance options.

confidential_instance_type

Defines the type of technology used by the confidential instance. Check the ConfidentialInstanceType enum for the list of possible values.

This field is a member of oneof _confidential_instance_type.

Type

str

enable_confidential_compute

Defines whether the instance should have confidential compute enabled.

This field is a member of oneof _enable_confidential_compute.

Type

bool

class ConfidentialInstanceType(value)

Bases: proto.enums.Enum

Defines the type of technology used by the confidential instance.

Values:

UNDEFINED_CONFIDENTIAL_INSTANCE_TYPE (0):

A value indicating that the enum field is not set.

CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED (115021829):

No type specified. Do not use this value.

SEV (81988):

AMD Secure Encrypted Virtualization.

SEV_SNP (21753562):

AMD Secure Encrypted Virtualization - Secure Nested Paging.

TDX (82920):

Intel Trust Domain eXtension.

class google.cloud.compute_v1.types.ConnectionDraining(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Message containing connection draining configuration.

draining_timeout_sec

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

This field is a member of oneof _draining_timeout_sec.

Type

int

class google.cloud.compute_v1.types.ConsistentHashLoadBalancerSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

http_cookie

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

This field is a member of oneof _http_cookie.

Type

google.cloud.compute_v1.types.ConsistentHashLoadBalancerSettingsHttpCookie

http_header_name

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

This field is a member of oneof _http_header_name.

Type

str

minimum_ring_size

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

This field is a member of oneof _minimum_ring_size.

Type

int

class google.cloud.compute_v1.types.ConsistentHashLoadBalancerSettingsHttpCookie(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Name of the cookie.

This field is a member of oneof _name.

Type

str

path

Path to set for the cookie.

This field is a member of oneof _path.

Type

str

ttl

Lifetime of the cookie.

This field is a member of oneof _ttl.

Type

google.cloud.compute_v1.types.Duration

class google.cloud.compute_v1.types.CorsPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

allow_credentials

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

This field is a member of oneof _allow_credentials.

Type

bool

allow_headers

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

Type

MutableSequence[str]

allow_methods

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

Type

MutableSequence[str]

allow_origin_regexes

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

Type

MutableSequence[str]

allow_origins

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

Type

MutableSequence[str]

disabled

If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.

This field is a member of oneof _disabled.

Type

bool

expose_headers

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

Type

MutableSequence[str]

max_age

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

This field is a member of oneof _max_age.

Type

int

class google.cloud.compute_v1.types.CreateInstancesInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.CreateInstances. See the method description for details.

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

instance_group_managers_create_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersCreateInstancesRequest

project

Project ID for this request.

Type

str

request_id

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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the managed instance group is located. It should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.CreateInstancesRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.CreateInstances. See the method description for details.

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region where the managed instance group is located. It should conform to RFC1035.

Type

str

region_instance_group_managers_create_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagersCreateInstancesRequest

request_id

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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.CreateSnapshotDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.CreateSnapshot. See the method description for details.

disk

Name of the persistent disk to snapshot.

Type

str

guest_flush

[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.

This field is a member of oneof _guest_flush.

Type

bool

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

snapshot_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Snapshot

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.CreateSnapshotRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.CreateSnapshot. See the method description for details.

disk

Name of the regional persistent disk to snapshot.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

snapshot_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Snapshot

class google.cloud.compute_v1.types.CustomErrorResponsePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specifies the custom error response policy that must be applied when the backend service or backend bucket responds with an error.

error_response_rules

Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for 401 (Un-authorized) code, and another for all 4 series error codes (4XX). If the backend service returns a 401, then the rule for 401 will be applied. However if the backend service returns a 403, the rule for 4xx takes effect.

Type

MutableSequence[google.cloud.compute_v1.types.CustomErrorResponsePolicyCustomErrorResponseRule]

error_service

The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers.

This field is a member of oneof _error_service.

Type

str

class google.cloud.compute_v1.types.CustomErrorResponsePolicyCustomErrorResponseRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specifies the mapping between the response code that will be returned along with the custom error content and the response code returned by the backend service.

match_response_codes

Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy.

Type

MutableSequence[str]

override_response_code

The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client.

This field is a member of oneof _override_response_code.

Type

int

path

The full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters

This field is a member of oneof _path.

Type

str

class google.cloud.compute_v1.types.CustomerEncryptionKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

kms_key_name

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

This field is a member of oneof _kms_key_name.

Type

str

kms_key_service_account

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

This field is a member of oneof _kms_key_service_account.

Type

str

raw_key

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

This field is a member of oneof _raw_key.

Type

str

rsa_encrypted_key

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

This field is a member of oneof _rsa_encrypted_key.

Type

str

sha256

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

This field is a member of oneof _sha256.

Type

str

class google.cloud.compute_v1.types.CustomerEncryptionKeyProtectedDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

disk_encryption_key

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

This field is a member of oneof _disk_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source

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

This field is a member of oneof _source.

Type

str

class google.cloud.compute_v1.types.Data(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This field is a member of oneof _key.

Type

str

value

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

This field is a member of oneof _value.

Type

str

class google.cloud.compute_v1.types.DeleteAccessConfigInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.DeleteAccessConfig. See the method description for details.

access_config

The name of the access config to delete.

Type

str

instance

The instance name for this request.

Type

str

network_interface

The name of the network interface.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Addresses.Delete. See the method description for details.

address

Name of the address resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Autoscalers.Delete. See the method description for details.

autoscaler

Name of the autoscaler to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.Delete. See the method description for details.

backend_bucket

Name of the BackendBucket resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.Delete. See the method description for details.

backend_service

Name of the BackendService resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.Delete. See the method description for details.

disk

Name of the persistent disk to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteExternalVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ExternalVpnGateways.Delete. See the method description for details.

external_vpn_gateway

Name of the externalVpnGateways to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.Delete. See the method description for details.

firewall_policy

Name of the firewall policy to delete.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteFirewallRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Firewalls.Delete. See the method description for details.

firewall

Name of the firewall rule to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ForwardingRules.Delete. See the method description for details.

forwarding_rule

Name of the ForwardingRule resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteGlobalAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalAddresses.Delete. See the method description for details.

address

Name of the address resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteGlobalForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalForwardingRules.Delete. See the method description for details.

forwarding_rule

Name of the ForwardingRule resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteGlobalNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalNetworkEndpointGroups.Delete. See the method description for details.

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteGlobalOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalOperations.Delete. See the method description for details.

operation

Name of the Operations resource to delete, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.DeleteGlobalOperationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A response message for GlobalOperations.Delete. See the method description for details.

class google.cloud.compute_v1.types.DeleteGlobalOrganizationOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalOrganizationOperations.Delete. See the method description for details.

operation

Name of the Operations resource to delete, or its unique numeric identifier.

Type

str

parent_id

Parent ID for this request.

This field is a member of oneof _parent_id.

Type

str

class google.cloud.compute_v1.types.DeleteGlobalOrganizationOperationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A response message for GlobalOrganizationOperations.Delete. See the method description for details.

class google.cloud.compute_v1.types.DeleteGlobalPublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalPublicDelegatedPrefixes.Delete. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix

Name of the PublicDelegatedPrefix resource to delete.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for HealthChecks.Delete. See the method description for details.

health_check

Name of the HealthCheck resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.Delete. See the method description for details.

image

Name of the image resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.Delete. See the method description for details.

instance_group_manager

The name of the managed instance group to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.DeleteInstanceGroupManagerResizeRequestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagerResizeRequests.Delete. See the method description for details.

instance_group_manager

The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

resize_request

The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.

Type

str

zone

The name of the zone where the managed instance group is located. The name should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.DeleteInstanceGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.Delete. See the method description for details.

instance_group

The name of the instance group to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.DeleteInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Delete. See the method description for details.

instance

Name of the instance resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceTemplates.Delete. See the method description for details.

instance_template

The name of the instance template to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteInstancesInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.DeleteInstances. See the method description for details.

instance_group_manager

The name of the managed instance group.

Type

str

instance_group_managers_delete_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersDeleteInstancesRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.DeleteInstancesRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.DeleteInstances. See the method description for details.

instance_group_manager

Name of the managed instance group.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_instance_group_managers_delete_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagersDeleteInstancesRequest

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.Delete. See the method description for details.

instant_snapshot

Name of the InstantSnapshot resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteInterconnectAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectAttachments.Delete. See the method description for details.

interconnect_attachment

Name of the interconnect attachment to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteInterconnectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Interconnects.Delete. See the method description for details.

interconnect

Name of the interconnect to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Licenses.Delete. See the method description for details.

license_

Name of the license resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteMachineImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineImages.Delete. See the method description for details.

machine_image

The name of the machine image to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteNetworkAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.Delete. See the method description for details.

network_attachment

Name of the NetworkAttachment resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

request_id

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). end_interface: MixerMutationRequestBuilder

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteNetworkEdgeSecurityServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEdgeSecurityServices.Delete. See the method description for details.

network_edge_security_service

Name of the network edge security service to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.Delete. See the method description for details.

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.DeleteNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.Delete. See the method description for details.

firewall_policy

Name of the firewall policy to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.Delete. See the method description for details.

network

Name of the network to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.Delete. See the method description for details.

node_group

Name of the NodeGroup resource to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteNodeTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTemplates.Delete. See the method description for details.

node_template

Name of the NodeTemplate resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteNodesNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.DeleteNodes. See the method description for details.

node_group

Name of the NodeGroup resource whose nodes will be deleted.

Type

str

node_groups_delete_nodes_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NodeGroupsDeleteNodesRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeletePacketMirroringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PacketMirrorings.Delete. See the method description for details.

packet_mirroring

Name of the PacketMirroring resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeletePerInstanceConfigsInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.DeletePerInstanceConfigs. See the method description for details.

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

instance_group_managers_delete_per_instance_configs_req_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersDeletePerInstanceConfigsReq

project

Project ID for this request.

Type

str

zone

The name of the zone where the managed instance group is located. It should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.DeletePerInstanceConfigsRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.DeletePerInstanceConfigs. See the method description for details.

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request, should conform to RFC1035.

Type

str

region_instance_group_manager_delete_instance_config_req_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagerDeleteInstanceConfigReq

class google.cloud.compute_v1.types.DeletePublicAdvertisedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicAdvertisedPrefixes.Delete. See the method description for details.

project

Project ID for this request.

Type

str

public_advertised_prefix

Name of the PublicAdvertisedPrefix resource to delete.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeletePublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicDelegatedPrefixes.Delete. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix

Name of the PublicDelegatedPrefix resource to delete.

Type

str

region

Name of the region of this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionAutoscalers.Delete. See the method description for details.

autoscaler

Name of the autoscaler to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.Delete. See the method description for details.

backend_service

Name of the BackendService resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.Delete. See the method description for details.

disk

Name of the regional persistent disk to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthChecks.Delete. See the method description for details.

health_check

Name of the HealthCheck resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionHealthCheckServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthCheckServices.Delete. See the method description for details.

health_check_service

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

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.Delete. See the method description for details.

instance_group_manager

Name of the managed instance group to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceTemplates.Delete. See the method description for details.

instance_template

The name of the instance template to delete.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstantSnapshots.Delete. See the method description for details.

instant_snapshot

Name of the InstantSnapshot resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkEndpointGroups.Delete. See the method description for details.

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

region

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

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.Delete. See the method description for details.

firewall_policy

Name of the firewall policy to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionNotificationEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNotificationEndpoints.Delete. See the method description for details.

notification_endpoint

Name of the NotificationEndpoint resource to delete.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteRegionOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionOperations.Delete. See the method description for details.

operation

Name of the Operations resource to delete, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

class google.cloud.compute_v1.types.DeleteRegionOperationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A response message for RegionOperations.Delete. See the method description for details.

class google.cloud.compute_v1.types.DeleteRegionSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

security_policy

Name of the security policy to delete.

Type

str

class google.cloud.compute_v1.types.DeleteRegionSslCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslCertificates.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

ssl_certificate

Name of the SslCertificate resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteRegionSslPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslPolicies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

ssl_policy

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

Type

str

class google.cloud.compute_v1.types.DeleteRegionTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpProxies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_http_proxy

Name of the TargetHttpProxy resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteRegionTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpsProxies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_https_proxy

Name of the TargetHttpsProxy resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteRegionTargetTcpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetTcpProxies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_tcp_proxy

Name of the TargetTcpProxy resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteRegionUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionUrlMaps.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

This field is a member of oneof _request_id.

Type

str

url_map

Name of the UrlMap resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

reservation

Name of the reservation to delete.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteResourcePolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

resource_policy

Name of the resource policy to delete.

Type

str

class google.cloud.compute_v1.types.DeleteRouteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routes.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

route

Name of the Route resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteRouterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

router

Name of the Router resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

security_policy

Name of the security policy to delete.

Type

str

class google.cloud.compute_v1.types.DeleteServiceAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

service_attachment

Name of the ServiceAttachment resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteSignedUrlKeyBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.DeleteSignedUrlKey. See the method description for details.

backend_bucket

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

Type

str

key_name

The name of the Signed URL Key to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteSignedUrlKeyBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.DeleteSignedUrlKey. See the method description for details.

backend_service

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

Type

str

key_name

The name of the Signed URL Key to delete.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeleteSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Snapshots.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

snapshot

Name of the Snapshot resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteSslCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslCertificates.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

ssl_certificate

Name of the SslCertificate resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteSslPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslPolicies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

ssl_policy

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

Type

str

class google.cloud.compute_v1.types.DeleteStoragePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

storage_pool

Name of the storage pool to delete.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteSubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

subnetwork

Name of the Subnetwork resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteTargetGrpcProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetGrpcProxies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_grpc_proxy

Name of the TargetGrpcProxy resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpProxies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_http_proxy

Name of the TargetHttpProxy resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_https_proxy

Name of the TargetHttpsProxy resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteTargetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetInstances.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_instance

Name of the TargetInstance resource to delete.

Type

str

zone

Name of the zone scoping this request.

Type

str

class google.cloud.compute_v1.types.DeleteTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_pool

Name of the TargetPool resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteTargetSslProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_ssl_proxy

Name of the TargetSslProxy resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteTargetTcpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetTcpProxies.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_tcp_proxy

Name of the TargetTcpProxy resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteTargetVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetVpnGateways.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

target_vpn_gateway

Name of the target VPN gateway to delete.

Type

str

class google.cloud.compute_v1.types.DeleteUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.Delete. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

url_map

Name of the UrlMap resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnGateways.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

vpn_gateway

Name of the VPN gateway to delete.

Type

str

class google.cloud.compute_v1.types.DeleteVpnTunnelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnTunnels.Delete. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

vpn_tunnel

Name of the VpnTunnel resource to delete.

Type

str

class google.cloud.compute_v1.types.DeleteZoneOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ZoneOperations.Delete. See the method description for details.

operation

Name of the Operations resource to delete, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DeleteZoneOperationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A response message for ZoneOperations.Delete. See the method description for details.

class google.cloud.compute_v1.types.Denied(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

I_p_protocol

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.

This field is a member of oneof _I_p_protocol.

Type

str

ports

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

Type

MutableSequence[str]

class google.cloud.compute_v1.types.DeprecateImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.Deprecate. See the method description for details.

deprecation_status_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DeprecationStatus

image

Image name.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DeprecationStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Deprecation status for a public resource.

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.

This field is a member of oneof _deleted.

Type

str

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.

This field is a member of oneof _deprecated.

Type

str

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.

This field is a member of oneof _obsolete.

Type

str

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.

This field is a member of oneof _replacement.

Type

str

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. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class State(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

No description available.

DELETED (120962041):

No description available.

DEPRECATED (463360435):

No description available.

OBSOLETE (66532761):

No description available.

class google.cloud.compute_v1.types.DetachDiskInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.DetachDisk. See the method description for details.

device_name

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

Type

str

instance

Instance name for this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalNetworkEndpointGroups.DetachNetworkEndpoints. See the method description for details.

global_network_endpoint_groups_detach_endpoints_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalNetworkEndpointGroupsDetachEndpointsRequest

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DetachNetworkEndpointsNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.DetachNetworkEndpoints. See the method description for details.

network_endpoint_group

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

Type

str

network_endpoint_groups_detach_endpoints_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkEndpointGroupsDetachEndpointsRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.DetachNetworkEndpointsRegionNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkEndpointGroups.DetachNetworkEndpoints. See the method description for details.

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

region

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

Type

str

region_network_endpoint_groups_detach_endpoints_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionNetworkEndpointGroupsDetachEndpointsRequest

request_id

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). end_interface: MixerMutationRequestBuilder

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DisableXpnHostProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.DisableXpnHost. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.DisableXpnResourceProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.DisableXpnResource. See the method description for details.

project

Project ID for this request.

Type

str

projects_disable_xpn_resource_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ProjectsDisableXpnResourceRequest

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.Disk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

access_mode

The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types. Check the AccessMode enum for the list of possible values.

This field is a member of oneof _access_mode.

Type

str

architecture

The architecture of the disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

This field is a member of oneof _architecture.

Type

str

async_primary_disk

Disk asynchronously replicated into this disk.

This field is a member of oneof _async_primary_disk.

Type

google.cloud.compute_v1.types.DiskAsyncReplication

async_secondary_disks

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

Type

MutableMapping[str, google.cloud.compute_v1.types.DiskAsyncReplicationList]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

disk_encryption_key

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

This field is a member of oneof _disk_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

enable_confidential_compute

Whether this disk is using confidential compute mode.

This field is a member of oneof _enable_confidential_compute.

Type

bool

guest_os_features

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

Type

MutableSequence[google.cloud.compute_v1.types.GuestOsFeature]

id

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

This field is a member of oneof _id.

Type

int

kind

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

This field is a member of oneof _kind.

Type

str

label_fingerprint

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

This field is a member of oneof _label_fingerprint.

Type

str

labels

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

Type

MutableMapping[str, str]

last_attach_timestamp

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

This field is a member of oneof _last_attach_timestamp.

Type

str

last_detach_timestamp

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

This field is a member of oneof _last_detach_timestamp.

Type

str

license_codes

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

Type

MutableSequence[int]

licenses

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

Type

MutableSequence[str]

location_hint

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

This field is a member of oneof _location_hint.

Type

str

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.

This field is a member of oneof _name.

Type

str

options

Internal use only.

This field is a member of oneof _options.

Type

str

params

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

This field is a member of oneof _params.

Type

google.cloud.compute_v1.types.DiskParams

physical_block_size_bytes

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

This field is a member of oneof _physical_block_size_bytes.

Type

int

provisioned_iops

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

This field is a member of oneof _provisioned_iops.

Type

int

provisioned_throughput

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.

This field is a member of oneof _provisioned_throughput.

Type

int

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.

This field is a member of oneof _region.

Type

str

replica_zones

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

Type

MutableSequence[str]

resource_policies

Resource policies applied to this disk for automatic snapshot creations.

Type

MutableSequence[str]

resource_status

[Output Only] Status information for the disk resource.

This field is a member of oneof _resource_status.

Type

google.cloud.compute_v1.types.DiskResourceStatus

satisfies_pzi

Output only. Reserved for future use.

This field is a member of oneof _satisfies_pzi.

Type

bool

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

self_link

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

This field is a member of oneof _self_link.

Type

str

size_gb

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

This field is a member of oneof _size_gb.

Type

int

source_consistency_group_policy

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

This field is a member of oneof _source_consistency_group_policy.

Type

str

source_consistency_group_policy_id

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

This field is a member of oneof _source_consistency_group_policy_id.

Type

str

source_disk

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

This field is a member of oneof _source_disk.

Type

str

source_disk_id

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

This field is a member of oneof _source_disk_id.

Type

str

source_image

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

This field is a member of oneof _source_image.

Type

str

source_image_encryption_key

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

This field is a member of oneof _source_image_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_image_id

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

This field is a member of oneof _source_image_id.

Type

str

source_instant_snapshot

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

This field is a member of oneof _source_instant_snapshot.

Type

str

source_instant_snapshot_id

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

This field is a member of oneof _source_instant_snapshot_id.

Type

str

source_snapshot

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

This field is a member of oneof _source_snapshot.

Type

str

source_snapshot_encryption_key

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

This field is a member of oneof _source_snapshot_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_snapshot_id

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

This field is a member of oneof _source_snapshot_id.

Type

str

source_storage_object

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

This field is a member of oneof _source_storage_object.

Type

str

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. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

storage_pool

The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

This field is a member of oneof _storage_pool.

Type

str

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-ssd . See Persistent disk types.

This field is a member of oneof _type.

Type

str

users

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

Type

MutableSequence[str]

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.

This field is a member of oneof _zone.

Type

str

class AccessMode(value)

Bases: proto.enums.Enum

The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types.

Values:

UNDEFINED_ACCESS_MODE (0):

A value indicating that the enum field is not set.

READ_ONLY_MANY (63460265):

The AccessMode means the disk can be attached to multiple instances in RO mode.

READ_WRITE_MANY (488743208):

The AccessMode means the disk can be attached to multiple instances in RW mode.

READ_WRITE_SINGLE (99323089):

The default AccessMode, means the disk can be attached to single instance in RW mode.

class Architecture(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_ARCHITECTURE (0):

A value indicating that the enum field is not set.

ARCHITECTURE_UNSPECIFIED (394750507):

Default value indicating Architecture is not set.

ARM64 (62547450):

Machines with architecture ARM64

X86_64 (425300551):

Machines with architecture X86_64

class AsyncSecondaryDisksEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Status(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

Disk is provisioning

DELETING (528602024):

Disk is deleting.

FAILED (455706685):

Disk creation failed.

READY (77848963):

Disk is ready for use.

RESTORING (404263851):

Source data is being copied into the disk.

UNAVAILABLE (413756464):

Disk is currently unavailable and cannot be accessed, attached or detached.

class google.cloud.compute_v1.types.DiskAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of DisksScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.DisksScopedList]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.DiskAsyncReplication(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

consistency_group_policy

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

This field is a member of oneof _consistency_group_policy.

Type

str

consistency_group_policy_id

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

This field is a member of oneof _consistency_group_policy_id.

Type

str

disk

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

This field is a member of oneof _disk.

Type

str

disk_id

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

This field is a member of oneof _disk_id.

Type

str

class google.cloud.compute_v1.types.DiskAsyncReplicationList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

async_replication_disk

This field is a member of oneof _async_replication_disk.

Type

google.cloud.compute_v1.types.DiskAsyncReplication

class google.cloud.compute_v1.types.DiskInstantiationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

auto_delete

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

This field is a member of oneof _auto_delete.

Type

bool

custom_image

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

This field is a member of oneof _custom_image.

Type

str

device_name

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

This field is a member of oneof _device_name.

Type

str

instantiate_from

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

This field is a member of oneof _instantiate_from.

Type

str

class InstantiateFrom(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_INSTANTIATE_FROM (0):

A value indicating that the enum field is not set.

ATTACH_READ_ONLY (513775419):

Attach the existing disk in read-only mode. The request will fail if the disk was attached in read-write mode on the source instance. Applicable to: read-only disks.

BLANK (63281460):

Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.

CUSTOM_IMAGE (196311789):

Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.

DEFAULT (115302945):

Use the default instantiation option for the corresponding type of disk. For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.

DO_NOT_INCLUDE (104218952):

Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.

SOURCE_IMAGE (62631959):

Use the same source image used for creation of the source instance’s corresponding disk. The request will fail if the source VM’s disk was created from a snapshot. Applicable to: boot disk, additional read-write disks.

SOURCE_IMAGE_FAMILY (76850316):

Use the same source image family used for creation of the source instance’s corresponding disk. The request will fail if the source image of the source disk does not belong to any image family. Applicable to: boot disk, additional read-write disks.

class google.cloud.compute_v1.types.DiskList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of Disk resources.

id

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

This field is a member of oneof _id.

Type

str

items

A list of Disk resources.

Type

MutableSequence[google.cloud.compute_v1.types.Disk]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.DiskMoveRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

destination_zone

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

This field is a member of oneof _destination_zone.

Type

str

target_disk

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

This field is a member of oneof _target_disk.

Type

str

class google.cloud.compute_v1.types.DiskParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional disk params.

resource_manager_tags

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

Type

MutableMapping[str, str]

class ResourceManagerTagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.DiskResourceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

async_primary_disk

This field is a member of oneof _async_primary_disk.

Type

google.cloud.compute_v1.types.DiskResourceStatusAsyncReplicationStatus

async_secondary_disks

Key: disk, value: AsyncReplicationStatus message

Type

MutableMapping[str, google.cloud.compute_v1.types.DiskResourceStatusAsyncReplicationStatus]

class AsyncSecondaryDisksEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.DiskResourceStatusAsyncReplicationStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

state

Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class State(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

Replication is active.

CREATED (135924424):

Secondary disk is created and is waiting for replication to start.

STARTING (488820800):

Replication is starting.

STATE_UNSPECIFIED (470755401):

No description available.

STOPPED (444276141):

Replication is stopped.

STOPPING (350791796):

Replication is stopping.

class google.cloud.compute_v1.types.DiskType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

default_disk_size_gb

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

This field is a member of oneof _default_disk_size_gb.

Type

int

deprecated

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

This field is a member of oneof _deprecated.

Type

google.cloud.compute_v1.types.DeprecationStatus

description

[Output Only] An optional description of this resource.

This field is a member of oneof _description.

Type

str

id

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

This field is a member of oneof _id.

Type

int

kind

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

This field is a member of oneof _kind.

Type

str

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

region

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

This field is a member of oneof _region.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

valid_disk_size

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

This field is a member of oneof _valid_disk_size.

Type

str

zone

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

This field is a member of oneof _zone.

Type

str

class google.cloud.compute_v1.types.DiskTypeAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of DiskTypesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.DiskTypesScopedList]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.DiskTypeList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of disk types.

id

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

This field is a member of oneof _id.

Type

str

items

A list of DiskType resources.

Type

MutableSequence[google.cloud.compute_v1.types.DiskType]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.DiskTypesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

disk_types

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

Type

MutableSequence[google.cloud.compute_v1.types.DiskType]

warning

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

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.DisksAddResourcePoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource_policies

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

Type

MutableSequence[str]

class google.cloud.compute_v1.types.DisksRemoveResourcePoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource_policies

Resource policies to be removed from this disk.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.DisksResizeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

size_gb

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

This field is a member of oneof _size_gb.

Type

int

class google.cloud.compute_v1.types.DisksScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

disks

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

Type

MutableSequence[google.cloud.compute_v1.types.Disk]

warning

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

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.DisksStartAsyncReplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

async_secondary_disk

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

This field is a member of oneof _async_secondary_disk.

Type

str

class google.cloud.compute_v1.types.DisksStopGroupAsyncReplicationResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

resource_policy

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

This field is a member of oneof _resource_policy.

Type

str

class google.cloud.compute_v1.types.DisplayDevice(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A set of Display Device options

enable_display

Defines whether the instance has Display enabled.

This field is a member of oneof _enable_display.

Type

bool

class google.cloud.compute_v1.types.DistributionPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target_shape

The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). Check the TargetShape enum for the list of possible values.

This field is a member of oneof _target_shape.

Type

str

zones

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

Type

MutableSequence[google.cloud.compute_v1.types.DistributionPolicyZoneConfiguration]

class TargetShape(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_TARGET_SHAPE (0):

A value indicating that the enum field is not set.

ANY (64972):

The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.

ANY_SINGLE_ZONE (61100880):

The group creates all VM instances within a single zone. The zone is selected based on the present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads with heavy interprocess communication.

BALANCED (468409608):

The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.

EVEN (2140442):

The group schedules VM instance creation and deletion to achieve and maintain an even number of managed instances across the selected zones. The distribution is even when the number of managed instances does not differ by more than 1 between any two zones. Recommended for highly available serving workloads.

class google.cloud.compute_v1.types.DistributionPolicyZoneConfiguration(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

zone

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

This field is a member of oneof _zone.

Type

str

class google.cloud.compute_v1.types.Duration(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

nanos

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

This field is a member of oneof _nanos.

Type

int

seconds

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

This field is a member of oneof _seconds.

Type

int

class google.cloud.compute_v1.types.EnableXpnHostProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.EnableXpnHost. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.EnableXpnResourceProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.EnableXpnResource. See the method description for details.

project

Project ID for this request.

Type

str

projects_enable_xpn_resource_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ProjectsEnableXpnResourceRequest

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.Error(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Errors that prevented the ResizeRequest to be fulfilled.

errors

[Output Only] The array of errors encountered while processing this operation.

Type

MutableSequence[google.cloud.compute_v1.types.Errors]

class google.cloud.compute_v1.types.ErrorDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

error_info

This field is a member of oneof _error_info.

Type

google.cloud.compute_v1.types.ErrorInfo

help_

This field is a member of oneof _help.

Type

google.cloud.compute_v1.types.Help

localized_message

This field is a member of oneof _localized_message.

Type

google.cloud.compute_v1.types.LocalizedMessage

quota_info

This field is a member of oneof _quota_info.

Type

google.cloud.compute_v1.types.QuotaExceededInfo

class google.cloud.compute_v1.types.ErrorInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

domain

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

This field is a member of oneof _domain.

Type

str

metadatas

Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {“instanceLimit”: “100/request”}, should be returned as, {“instanceLimitPerRequest”: “100”}, if the client exceeds the number of instances that can be created in a single (batch) request.

Type

MutableMapping[str, str]

reason

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

This field is a member of oneof _reason.

Type

str

class MetadatasEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.Errors(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

code

[Output Only] The error type identifier for this error.

This field is a member of oneof _code.

Type

str

error_details

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.

Type

MutableSequence[google.cloud.compute_v1.types.ErrorDetails]

location

[Output Only] Indicates the field in the request that caused the error. This property is optional.

This field is a member of oneof _location.

Type

str

message

[Output Only] An optional, human-readable error message.

This field is a member of oneof _message.

Type

str

class google.cloud.compute_v1.types.ExchangedPeeringRoute(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

dest_range

The destination range of the route.

This field is a member of oneof _dest_range.

Type

str

imported

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

This field is a member of oneof _imported.

Type

bool

next_hop_region

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

This field is a member of oneof _next_hop_region.

Type

str

priority

The priority of the peering route.

This field is a member of oneof _priority.

Type

int

type_

The type of the peering route. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

The type of the peering route.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

DYNAMIC_PEERING_ROUTE (469794858):

For routes exported from local network.

STATIC_PEERING_ROUTE (473407545):

The peering route.

SUBNET_PEERING_ROUTE (465782504):

The peering route corresponding to subnetwork range.

class google.cloud.compute_v1.types.ExchangedPeeringRoutesList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of ExchangedPeeringRoute resources.

Type

MutableSequence[google.cloud.compute_v1.types.ExchangedPeeringRoute]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ExpandIpCidrRangeSubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.ExpandIpCidrRange. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

subnetwork

Name of the Subnetwork resource to update.

Type

str

subnetworks_expand_ip_cidr_range_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SubnetworksExpandIpCidrRangeRequest

class google.cloud.compute_v1.types.Expr(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

description

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

This field is a member of oneof _description.

Type

str

expression

Textual representation of an expression in Common Expression Language syntax.

This field is a member of oneof _expression.

Type

str

location

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

This field is a member of oneof _location.

Type

str

title

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.

This field is a member of oneof _title.

Type

str

class google.cloud.compute_v1.types.ExternalVpnGateway(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

id

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

This field is a member of oneof _id.

Type

int

interfaces

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

Type

MutableSequence[google.cloud.compute_v1.types.ExternalVpnGatewayInterface]

kind

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

This field is a member of oneof _kind.

Type

str

label_fingerprint

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

This field is a member of oneof _label_fingerprint.

Type

str

labels

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

Type

MutableMapping[str, str]

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.

This field is a member of oneof _name.

Type

str

redundancy_type

Indicates the user-supplied redundancy type of this external VPN gateway. Check the RedundancyType enum for the list of possible values.

This field is a member of oneof _redundancy_type.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class RedundancyType(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_REDUNDANCY_TYPE (0):

A value indicating that the enum field is not set.

FOUR_IPS_REDUNDANCY (520087913):

The external VPN gateway has four public IP addresses; at the time of writing this API, the AWS virtual private gateway is an example which has four public IP addresses for high availability connections; there should be two VPN connections in the AWS virtual private gateway , each AWS VPN connection has two public IP addresses; please make sure to put two public IP addresses from one AWS VPN connection into interfaces 0 and 1 of this external VPN gateway, and put the other two public IP addresses from another AWS VPN connection into interfaces 2 and 3 of this external VPN gateway. When displaying highly available configuration status for the VPN tunnels connected to FOUR_IPS_REDUNDANCY external VPN gateway, Google will always detect whether interfaces 0 and 1 are connected on one interface of HA Cloud VPN gateway, and detect whether interfaces 2 and 3 are connected to another interface of the HA Cloud VPN gateway.

SINGLE_IP_INTERNALLY_REDUNDANT (133914873):

The external VPN gateway has only one public IP address which internally provide redundancy or failover.

TWO_IPS_REDUNDANCY (367049635):

The external VPN gateway has two public IP addresses which are redundant with each other, the following two types of setup on your on-premises side would have this type of redundancy: (1) Two separate on-premises gateways, each with one public IP address, the two on-premises gateways are redundant with each other. (2) A single on-premise gateway with two public IP addresses that are redundant with eatch other.

class google.cloud.compute_v1.types.ExternalVpnGatewayInterface(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The interface for the external VPN gateway.

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

This field is a member of oneof _id.

Type

int

ip_address

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.

This field is a member of oneof _ip_address.

Type

str

ipv6_address

IPv6 address of the interface in the external VPN gateway. This IPv6 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. Must specify an IPv6 address (not IPV4-mapped) using any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The output format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).

This field is a member of oneof _ipv6_address.

Type

str

class google.cloud.compute_v1.types.ExternalVpnGatewayList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

etag

This field is a member of oneof _etag.

Type

str

id

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

This field is a member of oneof _id.

Type

str

items

A list of ExternalVpnGateway resources.

Type

MutableSequence[google.cloud.compute_v1.types.ExternalVpnGateway]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.FileContentBuffer(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

content

The raw content in the secure keys file.

This field is a member of oneof _content.

Type

str

file_type

The file type of source file. Check the FileType enum for the list of possible values.

This field is a member of oneof _file_type.

Type

str

class FileType(value)

Bases: proto.enums.Enum

The file type of source file.

Values:

UNDEFINED_FILE_TYPE (0):

A value indicating that the enum field is not set.

BIN (65767):

No description available.

UNDEFINED (137851184):

No description available.

X509 (2674086):

No description available.

class google.cloud.compute_v1.types.Firewall(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

allowed

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

Type

MutableSequence[google.cloud.compute_v1.types.Allowed]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

denied

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

Type

MutableSequence[google.cloud.compute_v1.types.Denied]

description

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

This field is a member of oneof _description.

Type

str

destination_ranges

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

Type

MutableSequence[str]

direction

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

This field is a member of oneof _direction.

Type

str

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.

This field is a member of oneof _disabled.

Type

bool

id

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

This field is a member of oneof _id.

Type

int

kind

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

This field is a member of oneof _kind.

Type

str

log_config

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

This field is a member of oneof _log_config.

Type

google.cloud.compute_v1.types.FirewallLogConfig

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.

This field is a member of oneof _name.

Type

str

network

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

This field is a member of oneof _network.

Type

str

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.

This field is a member of oneof _priority.

Type

int

self_link

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

This field is a member of oneof _self_link.

Type

str

source_ranges

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

Type

MutableSequence[str]

source_service_accounts

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

Type

MutableSequence[str]

source_tags

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

Type

MutableSequence[str]

target_service_accounts

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

Type

MutableSequence[str]

target_tags

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

Type

MutableSequence[str]

class Direction(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_DIRECTION (0):

A value indicating that the enum field is not set.

EGRESS (432880501):

Indicates that firewall should apply to outgoing traffic.

INGRESS (516931221):

Indicates that firewall should apply to incoming traffic.

class google.cloud.compute_v1.types.FirewallList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of firewalls.

id

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

This field is a member of oneof _id.

Type

str

items

A list of Firewall resources.

Type

MutableSequence[google.cloud.compute_v1.types.Firewall]

kind

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

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.FirewallLogConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The available logging options for a firewall rule.

enable

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

This field is a member of oneof _enable.

Type

bool

metadata

This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs. Check the Metadata enum for the list of possible values.

This field is a member of oneof _metadata.

Type

str

class Metadata(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_METADATA (0):

A value indicating that the enum field is not set.

EXCLUDE_ALL_METADATA (334519954):

No description available.

INCLUDE_ALL_METADATA (164619908):

No description available.

class google.cloud.compute_v1.types.FirewallPoliciesListAssociationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

associations

A list of associations.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyAssociation]

kind

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

This field is a member of oneof _kind.

Type

str

class google.cloud.compute_v1.types.FirewallPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Firewall Policy resource.

associations

A list of associations that belong to this firewall policy.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyAssociation]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

display_name

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

This field is a member of oneof _display_name.

Type

str

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. To see the latest fingerprint, make get() request to the firewall policy.

This field is a member of oneof _fingerprint.

Type

str

id

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

This field is a member of oneof _id.

Type

int

kind

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

This field is a member of oneof _kind.

Type

str

name

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

This field is a member of oneof _name.

Type

str

parent

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

This field is a member of oneof _parent.

Type

str

region

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

This field is a member of oneof _region.

Type

str

rule_tuple_count

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

This field is a member of oneof _rule_tuple_count.

Type

int

rules

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

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyRule]

self_link

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

This field is a member of oneof _self_link.

Type

str

self_link_with_id

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

This field is a member of oneof _self_link_with_id.

Type

str

short_name

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

This field is a member of oneof _short_name.

Type

str

class google.cloud.compute_v1.types.FirewallPolicyAssociation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

attachment_target

The target that the firewall policy is attached to.

This field is a member of oneof _attachment_target.

Type

str

display_name

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

This field is a member of oneof _display_name.

Type

str

firewall_policy_id

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

This field is a member of oneof _firewall_policy_id.

Type

str

name

The name for an association.

This field is a member of oneof _name.

Type

str

short_name

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

This field is a member of oneof _short_name.

Type

str

class google.cloud.compute_v1.types.FirewallPolicyList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of FirewallPolicy resources.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicy]

kind

[Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.FirewallPolicyRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

action

The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: “allow”, “deny”, “apply_security_profile_group” and “goto_next”. Valid actions for packet mirroring rules are: “mirror”, “do_not_mirror” and “goto_next”.

This field is a member of oneof _action.

Type

str

description

An optional description for this resource.

This field is a member of oneof _description.

Type

str

direction

The direction in which this rule applies. Check the Direction enum for the list of possible values.

This field is a member of oneof _direction.

Type

str

disabled

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

This field is a member of oneof _disabled.

Type

bool

enable_logging

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on “goto_next” rules.

This field is a member of oneof _enable_logging.

Type

bool

kind

[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.

This field is a member of oneof _kind.

Type

str

match

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ‘action’ is enforced.

This field is a member of oneof _match.

Type

google.cloud.compute_v1.types.FirewallPolicyRuleMatcher

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

This field is a member of oneof _priority.

Type

int

rule_name

An optional name for the rule. This field is not a unique identifier and can be updated.

This field is a member of oneof _rule_name.

Type

str

rule_tuple_count

[Output Only] Calculation of the complexity of a single firewall policy rule.

This field is a member of oneof _rule_tuple_count.

Type

int

security_profile_group

A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of ‘apply_security_profile_group’ or ‘mirror’. Cannot be specified for other actions.

This field is a member of oneof _security_profile_group.

Type

str

target_resources

A list of network resource URLs to which this rule applies. This field allows you to control which network’s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

Type

MutableSequence[str]

target_secure_tags

A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyRuleSecureTag]

target_service_accounts

A list of service accounts indicating the sets of instances that are applied with this rule.

Type

MutableSequence[str]

tls_inspect

Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = ‘apply_security_profile_group’ and cannot be set for other actions.

This field is a member of oneof _tls_inspect.

Type

bool

class Direction(value)

Bases: proto.enums.Enum

The direction in which this rule applies.

Values:

UNDEFINED_DIRECTION (0):

A value indicating that the enum field is not set.

EGRESS (432880501):

No description available.

INGRESS (516931221):

No description available.

class google.cloud.compute_v1.types.FirewallPolicyRuleMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.

dest_address_groups

Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.

Type

MutableSequence[str]

dest_fqdns

Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.

Type

MutableSequence[str]

dest_ip_ranges

CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.

Type

MutableSequence[str]

dest_region_codes

Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.”US” Maximum number of dest region codes allowed is 5000.

Type

MutableSequence[str]

dest_threat_intelligences

Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.

Type

MutableSequence[str]

layer4_configs

Pairs of IP protocols and ports that the rule should match.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyRuleMatcherLayer4Config]

src_address_groups

Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.

Type

MutableSequence[str]

src_fqdns

Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.

Type

MutableSequence[str]

src_ip_ranges

CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.

Type

MutableSequence[str]

src_region_codes

Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.”US” Maximum number of source region codes allowed is 5000.

Type

MutableSequence[str]

src_secure_tags

List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyRuleSecureTag]

src_threat_intelligences

Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.FirewallPolicyRuleMatcherLayer4Config(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ip_protocol

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.

This field is a member of oneof _ip_protocol.

Type

str

ports

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

Type

MutableSequence[str]

class google.cloud.compute_v1.types.FirewallPolicyRuleSecureTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

name

Name of the secure tag, created with TagManager’s TagValue API.

This field is a member of oneof _name.

Type

str

state

[Output Only] State of the secure tag, either EFFECTIVE or INEFFECTIVE. A secure tag is INEFFECTIVE when it is deleted or its network is deleted. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class State(value)

Bases: proto.enums.Enum

[Output Only] State of the secure tag, either EFFECTIVE or INEFFECTIVE. A secure tag is INEFFECTIVE when it is deleted or its network is deleted.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

EFFECTIVE (244201863):

No description available.

INEFFECTIVE (304458242):

No description available.

class google.cloud.compute_v1.types.FixedOrPercent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Encapsulates numeric value that can be either absolute or relative.

calculated

[Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.

This field is a member of oneof _calculated.

Type

int

fixed

Specifies a fixed number of VM instances. This must be a positive integer.

This field is a member of oneof _fixed.

Type

int

percent

Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

This field is a member of oneof _percent.

Type

int

class google.cloud.compute_v1.types.ForwardingRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * Global * Regional A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.

I_p_address

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in 100.1.2.3 * IPv6 address range, as in 2600:1234::/96 * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule’s target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see IP address specifications. When reading an IPAddress, the API always returns the IP address number.

This field is a member of oneof _I_p_address.

Type

str

I_p_protocol

The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in Load balancing features. Check the IPProtocolEnum enum for the list of possible values.

This field is a member of oneof _I_p_protocol.

Type

str

all_ports

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It’s applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.

This field is a member of oneof _all_ports.

Type

bool

allow_global_access

If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.

This field is a member of oneof _allow_global_access.

Type

bool

allow_psc_global_access

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

This field is a member of oneof _allow_psc_global_access.

Type

bool

backend_service

Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.

This field is a member of oneof _backend_service.

Type

str

base_forwarding_rule

[Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified.

This field is a member of oneof _base_forwarding_rule.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

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 ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.

This field is a member of oneof _fingerprint.

Type

str

id

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

This field is a member of oneof _id.

Type

int

ip_collection

Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name

This field is a member of oneof _ip_collection.

Type

str

ip_version

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. Check the IpVersion enum for the list of possible values.

This field is a member of oneof _ip_version.

Type

str

is_mirroring_collector

Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.

This field is a member of oneof _is_mirroring_collector.

Type

bool

kind

[Output Only] Type of the resource. Always compute#forwardingRule for forwarding rule resources.

This field is a member of oneof _kind.

Type

str

label_fingerprint

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

This field is a member of oneof _label_fingerprint.

Type

str

labels

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

Type

MutableMapping[str, str]

load_balancing_scheme

Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. Check the LoadBalancingScheme enum for the list of possible values.

This field is a member of oneof _load_balancing_scheme.

Type

str

metadata_filters

Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Type

MutableSequence[google.cloud.compute_v1.types.MetadataFilter]

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. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.

This field is a member of oneof _name.

Type

str

network

This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

This field is a member of oneof _network.

Type

str

network_tier

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. Check the NetworkTier enum for the list of possible values.

This field is a member of oneof _network_tier.

Type

str

no_automate_dns_zone

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable.

This field is a member of oneof _no_automate_dns_zone.

Type

bool

port_range

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It’s applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \d+(?:-d+)?

This field is a member of oneof _port_range.

Type

str

ports

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It’s applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-d+)?

Type

MutableSequence[str]

psc_connection_id

[Output Only] The PSC connection id of the PSC forwarding rule.

This field is a member of oneof _psc_connection_id.

Type

int

psc_connection_status

Check the PscConnectionStatus enum for the list of possible values.

This field is a member of oneof _psc_connection_status.

Type

str

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.

This field is a member of oneof _region.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

service_directory_registrations

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

Type

MutableSequence[google.cloud.compute_v1.types.ForwardingRuleServiceDirectoryRegistration]

service_label

An optional prefix to the service name for this forwarding rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.

This field is a member of oneof _service_label.

Type

str

service_name

[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing.

This field is a member of oneof _service_name.

Type

str

source_ip_ranges

If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a forwarding rule can only have up to 64 source IP ranges, and this field can only be used with a regional forwarding rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).

Type

MutableSequence[str]

subnetwork

This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.

This field is a member of oneof _subnetwork.

Type

str

target

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the “Target” column in Port specifications. - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.

This field is a member of oneof _target.

Type

str

class IPProtocolEnum(value)

Bases: proto.enums.Enum

The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in Load balancing features.

Values:

UNDEFINED_I_P_PROTOCOL_ENUM (0):

A value indicating that the enum field is not set.

AH (2087):

No description available.

ESP (68962):

No description available.

ICMP (2241597):

No description available.

L3_DEFAULT (48151369):

No description available.

SCTP (2539724):

No description available.

TCP (82881):

No description available.

UDP (83873):

No description available.

class IpVersion(value)

Bases: proto.enums.Enum

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.

Values:

UNDEFINED_IP_VERSION (0):

A value indicating that the enum field is not set.

IPV4 (2254341):

No description available.

IPV6 (2254343):

No description available.

UNSPECIFIED_VERSION (21850000):

No description available.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class LoadBalancingScheme(value)

Bases: proto.enums.Enum

Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.

Values:

UNDEFINED_LOAD_BALANCING_SCHEME (0):

A value indicating that the enum field is not set.

EXTERNAL (35607499):

No description available.

EXTERNAL_MANAGED (512006923):

No description available.

INTERNAL (279295677):

No description available.

INTERNAL_MANAGED (37350397):

No description available.

INTERNAL_SELF_MANAGED (236211150):

No description available.

INVALID (530283991):

No description available.

class NetworkTier(value)

Bases: proto.enums.Enum

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.

Values:

UNDEFINED_NETWORK_TIER (0):

A value indicating that the enum field is not set.

FIXED_STANDARD (310464328):

Public internet quality with fixed bandwidth.

PREMIUM (399530551):

High quality, Google-grade network tier, support for all networking products.

STANDARD (484642493):

Public internet quality, only limited support for other networking products.

STANDARD_OVERRIDES_FIXED_STANDARD (465847234):

(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

class PscConnectionStatus(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_PSC_CONNECTION_STATUS (0):

A value indicating that the enum field is not set.

ACCEPTED (246714279):

The connection has been accepted by the producer.

CLOSED (380163436):

The connection has been closed by the producer and will not serve traffic going forward.

NEEDS_ATTENTION (344491452):

The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.

PENDING (35394935):

The connection is pending acceptance by the producer.

REJECTED (174130302):

The connection has been rejected by the producer.

STATUS_UNSPECIFIED (42133066):

No description available.

class google.cloud.compute_v1.types.ForwardingRuleAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of ForwardingRulesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.ForwardingRulesScopedList]

kind

[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.ForwardingRuleList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of ForwardingRule resources.

id

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

This field is a member of oneof _id.

Type

str

items

A list of ForwardingRule resources.

Type

MutableSequence[google.cloud.compute_v1.types.ForwardingRule]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ForwardingRuleReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

forwarding_rule

This field is a member of oneof _forwarding_rule.

Type

str

class google.cloud.compute_v1.types.ForwardingRuleServiceDirectoryRegistration(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes the auto-registration of the forwarding rule to Service Directory. The region and project of the Service Directory resource generated from this registration will be the same as this forwarding rule.

namespace

Service Directory namespace to register the forwarding rule under.

This field is a member of oneof _namespace.

Type

str

service

Service Directory service to register the forwarding rule under.

This field is a member of oneof _service.

Type

str

service_directory_region

[Optional] Service Directory region to register this global forwarding rule under. Default to “us-central1”. Only used for PSC for Google APIs. All PSC for Google APIs forwarding rules on the same network should use the same Service Directory region.

This field is a member of oneof _service_directory_region.

Type

str

class google.cloud.compute_v1.types.ForwardingRulesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

forwarding_rules

A list of forwarding rules contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.ForwardingRule]

warning

Informational warning which replaces the list of forwarding rules when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.GRPCHealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

grpc_service_name

The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII.

This field is a member of oneof _grpc_service_name.

Type

str

port

The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.

This field is a member of oneof _port.

Type

int

port_name

Not supported.

This field is a member of oneof _port_name.

Type

str

port_specification

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Check the PortSpecification enum for the list of possible values.

This field is a member of oneof _port_specification.

Type

str

class PortSpecification(value)

Bases: proto.enums.Enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports.

Values:

UNDEFINED_PORT_SPECIFICATION (0):

A value indicating that the enum field is not set.

USE_FIXED_PORT (190235748):

The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.

USE_NAMED_PORT (349300671):

Not supported.

USE_SERVING_PORT (362637516):

For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.

class google.cloud.compute_v1.types.GetAcceleratorTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for AcceleratorTypes.Get. See the method description for details.

accelerator_type

Name of the accelerator type to return.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Addresses.Get. See the method description for details.

address

Name of the address resource to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetAssociationFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.GetAssociation. See the method description for details.

firewall_policy

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

Type

str

name

The name of the association to get from the firewall policy.

This field is a member of oneof _name.

Type

str

class google.cloud.compute_v1.types.GetAssociationNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.GetAssociation. See the method description for details.

firewall_policy

Name of the firewall policy to which the queried association belongs.

Type

str

name

The name of the association to get from the firewall policy.

This field is a member of oneof _name.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetAssociationRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.GetAssociation. See the method description for details.

firewall_policy

Name of the firewall policy to which the queried association belongs.

Type

str

name

The name of the association to get from the firewall policy.

This field is a member of oneof _name.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Autoscalers.Get. See the method description for details.

autoscaler

Name of the autoscaler to return.

Type

str

project

Project ID for this request.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.Get. See the method description for details.

backend_bucket

Name of the BackendBucket resource to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.Get. See the method description for details.

backend_service

Name of the BackendService resource to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetDiagnosticsInterconnectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Interconnects.GetDiagnostics. See the method description for details.

interconnect

Name of the interconnect resource to query.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.Get. See the method description for details.

disk

Name of the persistent disk to return.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetDiskTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for DiskTypes.Get. See the method description for details.

disk_type

Name of the disk type to return.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetEffectiveFirewallsInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.GetEffectiveFirewalls. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

network_interface

The name of the network interface to get the effective firewalls.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetEffectiveFirewallsNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.GetEffectiveFirewalls. See the method description for details.

network

Name of the network for this request.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetEffectiveFirewallsRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.GetEffectiveFirewalls. See the method description for details.

network

Network reference

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetExternalVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ExternalVpnGateways.Get. See the method description for details.

external_vpn_gateway

Name of the externalVpnGateway to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.Get. See the method description for details.

firewall_policy

Name of the firewall policy to get.

Type

str

class google.cloud.compute_v1.types.GetFirewallRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Firewalls.Get. See the method description for details.

firewall

Name of the firewall rule to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ForwardingRules.Get. See the method description for details.

forwarding_rule

Name of the ForwardingRule resource to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetFromFamilyImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.GetFromFamily. See the method description for details.

family

Name of the image family to search for.

Type

str

project

The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project.

Type

str

class google.cloud.compute_v1.types.GetGlobalAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalAddresses.Get. See the method description for details.

address

Name of the address resource to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetGlobalForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalForwardingRules.Get. See the method description for details.

forwarding_rule

Name of the ForwardingRule resource to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetGlobalNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalNetworkEndpointGroups.Get. See the method description for details.

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetGlobalOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalOperations.Get. See the method description for details.

operation

Name of the Operations resource to return, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetGlobalOrganizationOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalOrganizationOperations.Get. See the method description for details.

operation

Name of the Operations resource to return, or its unique numeric identifier.

Type

str

parent_id

Parent ID for this request.

This field is a member of oneof _parent_id.

Type

str

class google.cloud.compute_v1.types.GetGlobalPublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalPublicDelegatedPrefixes.Get. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix

Name of the PublicDelegatedPrefix resource to return.

Type

str

class google.cloud.compute_v1.types.GetGuestAttributesInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.GetGuestAttributes. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

query_path

Specifies the guest attributes path to be queried.

This field is a member of oneof _query_path.

Type

str

variable_key

Specifies the key for the guest attributes entry.

This field is a member of oneof _variable_key.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetHealthBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.GetHealth. See the method description for details.

backend_service

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

Type

str

project

Type

str

resource_group_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ResourceGroupReference

class google.cloud.compute_v1.types.GetHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for HealthChecks.Get. See the method description for details.

health_check

Name of the HealthCheck resource to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetHealthRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.GetHealth. See the method description for details.

backend_service

Name of the BackendService resource for which to get health.

Type

str

project

Type

str

region

Name of the region scoping this request.

Type

str

resource_group_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ResourceGroupReference

class google.cloud.compute_v1.types.GetHealthTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.GetHealth. See the method description for details.

instance_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceReference

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

target_pool

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

Type

str

class google.cloud.compute_v1.types.GetIamPolicyBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceTemplates.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Licenses.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyMachineImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineImages.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyNetworkAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyNodeTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTemplates.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyRegionInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstantSnapshots.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyResourcePolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyServiceAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicySnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Snapshots.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicyStoragePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetIamPolicySubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.GetIamPolicy. See the method description for details.

options_requested_policy_version

Requested IAM Policy version.

This field is a member of oneof _options_requested_policy_version.

Type

int

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.GetImageFamilyViewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ImageFamilyViews.Get. See the method description for details.

family

Name of the image family to search for.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.Get. See the method description for details.

image

Name of the image resource to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.Get. See the method description for details.

instance_group_manager

The name of the managed instance group.

Type

str

project

Project ID for this request.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.GetInstanceGroupManagerResizeRequestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagerResizeRequests.Get. See the method description for details.

instance_group_manager

The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.

Type

str

project

Project ID for this request.

Type

str

resize_request

The name of the resize request. Name should conform to RFC1035 or be a resource ID.

Type

str

zone

Name of the href=”/compute/docs/regions-zones/#available”>zone scoping this request. Name should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.GetInstanceGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.Get. See the method description for details.

instance_group

The name of the instance group.

Type

str

project

Project ID for this request.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.GetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Get. See the method description for details.

instance

Name of the instance resource to return.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetInstanceSettingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceSettingsService.Get. See the method description for details.

project

Project ID for this request.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceTemplates.Get. See the method description for details.

instance_template

The name of the instance template.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.Get. See the method description for details.

instant_snapshot

Name of the InstantSnapshot resource to return.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetInterconnectAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectAttachments.Get. See the method description for details.

interconnect_attachment

Name of the interconnect attachment to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetInterconnectLocationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectLocations.Get. See the method description for details.

interconnect_location

Name of the interconnect location to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetInterconnectRemoteLocationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectRemoteLocations.Get. See the method description for details.

interconnect_remote_location

Name of the interconnect remote location to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetInterconnectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Interconnects.Get. See the method description for details.

interconnect

Name of the interconnect to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetLicenseCodeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for LicenseCodes.Get. See the method description for details.

license_code

Number corresponding to the License code resource to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Licenses.Get. See the method description for details.

license_

Name of the License resource to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetMachineImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineImages.Get. See the method description for details.

machine_image

The name of the machine image.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetMachineTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineTypes.Get. See the method description for details.

machine_type

Name of the machine type to return.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetMacsecConfigInterconnectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Interconnects.GetMacsecConfig. See the method description for details.

interconnect

Name of the interconnect resource to query.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetNatIpInfoRouterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.GetNatIpInfo. See the method description for details.

nat_name

Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.

This field is a member of oneof _nat_name.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

router

Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.GetNatMappingInfoRoutersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.GetNatMappingInfo. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

nat_name

Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.

This field is a member of oneof _nat_name.

Type

str

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

router

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

Type

str

class google.cloud.compute_v1.types.GetNetworkAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.Get. See the method description for details.

network_attachment

Name of the NetworkAttachment resource to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

class google.cloud.compute_v1.types.GetNetworkEdgeSecurityServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEdgeSecurityServices.Get. See the method description for details.

network_edge_security_service

Name of the network edge security service to get.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.Get. See the method description for details.

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

zone

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

Type

str

class google.cloud.compute_v1.types.GetNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.Get. See the method description for details.

firewall_policy

Name of the firewall policy to get.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.Get. See the method description for details.

network

Name of the network to return.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.Get. See the method description for details.

node_group

Name of the node group to return.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetNodeTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTemplates.Get. See the method description for details.

node_template

Name of the node template to return.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetNodeTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTypes.Get. See the method description for details.

node_type

Name of the node type to return.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetPacketMirroringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PacketMirrorings.Get. See the method description for details.

packet_mirroring

Name of the PacketMirroring resource to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.Get. See the method description for details.

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetPublicAdvertisedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicAdvertisedPrefixes.Get. See the method description for details.

project

Project ID for this request.

Type

str

public_advertised_prefix

Name of the PublicAdvertisedPrefix resource to return.

Type

str

class google.cloud.compute_v1.types.GetPublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicDelegatedPrefixes.Get. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix

Name of the PublicDelegatedPrefix resource to return.

Type

str

region

Name of the region of this request.

Type

str

class google.cloud.compute_v1.types.GetRegionAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionAutoscalers.Get. See the method description for details.

autoscaler

Name of the autoscaler to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.Get. See the method description for details.

backend_service

Name of the BackendService resource to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRegionCommitmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionCommitments.Get. See the method description for details.

commitment

Name of the commitment to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.Get. See the method description for details.

disk

Name of the regional persistent disk to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetRegionDiskTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDiskTypes.Get. See the method description for details.

disk_type

Name of the disk type to return.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetRegionHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthChecks.Get. See the method description for details.

health_check

Name of the HealthCheck resource to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRegionHealthCheckServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthCheckServices.Get. See the method description for details.

health_check_service

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

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.Get. See the method description for details.

instance_group_manager

Name of the managed instance group to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRegionInstanceGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroups.Get. See the method description for details.

instance_group

Name of the instance group resource to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRegionInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceTemplates.Get. See the method description for details.

instance_template

The name of the instance template.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetRegionInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstantSnapshots.Get. See the method description for details.

instant_snapshot

Name of the InstantSnapshot resource to return.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetRegionNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkEndpointGroups.Get. See the method description for details.

network_endpoint_group

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

Type

str

project

Project ID for this request.

Type

str

region

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

Type

str

class google.cloud.compute_v1.types.GetRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.Get. See the method description for details.

firewall_policy

Name of the firewall policy to get.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRegionNotificationEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNotificationEndpoints.Get. See the method description for details.

notification_endpoint

Name of the NotificationEndpoint resource to return.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRegionOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionOperations.Get. See the method description for details.

operation

Name of the Operations resource to return, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

class google.cloud.compute_v1.types.GetRegionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Regions.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region resource to return.

Type

str

class google.cloud.compute_v1.types.GetRegionSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

security_policy

Name of the security policy to get.

Type

str

class google.cloud.compute_v1.types.GetRegionSslCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslCertificates.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

ssl_certificate

Name of the SslCertificate resource to return.

Type

str

class google.cloud.compute_v1.types.GetRegionSslPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslPolicies.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

ssl_policy

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

Type

str

class google.cloud.compute_v1.types.GetRegionTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpProxies.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

target_http_proxy

Name of the TargetHttpProxy resource to return.

Type

str

class google.cloud.compute_v1.types.GetRegionTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpsProxies.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

target_https_proxy

Name of the TargetHttpsProxy resource to return.

Type

str

class google.cloud.compute_v1.types.GetRegionTargetTcpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetTcpProxies.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

target_tcp_proxy

Name of the TargetTcpProxy resource to return.

Type

str

class google.cloud.compute_v1.types.GetRegionUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionUrlMaps.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

url_map

Name of the UrlMap resource to return.

Type

str

class google.cloud.compute_v1.types.GetReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.Get. See the method description for details.

project

Project ID for this request.

Type

str

reservation

Name of the reservation to retrieve.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetResourcePolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

resource_policy

Name of the resource policy to retrieve.

Type

str

class google.cloud.compute_v1.types.GetRouteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routes.Get. See the method description for details.

project

Project ID for this request.

Type

str

route

Name of the Route resource to return.

Type

str

class google.cloud.compute_v1.types.GetRouterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

router

Name of the Router resource to return.

Type

str

class google.cloud.compute_v1.types.GetRouterStatusRouterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.GetRouterStatus. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

router

Name of the Router resource to query.

Type

str

class google.cloud.compute_v1.types.GetRuleFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.GetRule. See the method description for details.

firewall_policy

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

Type

str

priority

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

This field is a member of oneof _priority.

Type

int

class google.cloud.compute_v1.types.GetRuleNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.GetRule. See the method description for details.

firewall_policy

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

Type

str

priority

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

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetRuleRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.GetRule. See the method description for details.

firewall_policy

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

Type

str

priority

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

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

class google.cloud.compute_v1.types.GetRuleRegionSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.GetRule. See the method description for details.

priority

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

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

security_policy

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

Type

str

class google.cloud.compute_v1.types.GetRuleSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.GetRule. See the method description for details.

priority

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

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

security_policy

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

Type

str

class google.cloud.compute_v1.types.GetScreenshotInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.GetScreenshot. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.Get. See the method description for details.

project

Project ID for this request.

Type

str

security_policy

Name of the security policy to get.

Type

str

class google.cloud.compute_v1.types.GetSerialPortOutputInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.GetSerialPortOutput. See the method description for details.

instance

Name of the instance for this request.

Type

str

port

Specifies which COM or serial port to retrieve data from.

This field is a member of oneof _port.

Type

int

project

Project ID for this request.

Type

str

start

Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to 0. If the output for that byte position is available, this field matches the start parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the start property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.

This field is a member of oneof _start.

Type

int

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetServiceAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

service_attachment

Name of the ServiceAttachment resource to return.

Type

str

class google.cloud.compute_v1.types.GetShieldedInstanceIdentityInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.GetShieldedInstanceIdentity. See the method description for details.

instance

Name or id of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Snapshots.Get. See the method description for details.

project

Project ID for this request.

Type

str

snapshot

Name of the Snapshot resource to return.

Type

str

class google.cloud.compute_v1.types.GetSnapshotSettingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SnapshotSettingsService.Get. See the method description for details.

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetSslCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslCertificates.Get. See the method description for details.

project

Project ID for this request.

Type

str

ssl_certificate

Name of the SslCertificate resource to return.

Type

str

class google.cloud.compute_v1.types.GetSslPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslPolicies.Get. See the method description for details.

project

Project ID for this request.

Type

str

ssl_policy

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

Type

str

class google.cloud.compute_v1.types.GetStatusVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnGateways.GetStatus. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

vpn_gateway

Name of the VPN gateway to return.

Type

str

class google.cloud.compute_v1.types.GetStoragePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.Get. See the method description for details.

project

Project ID for this request.

Type

str

storage_pool

Name of the storage pool to return.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetStoragePoolTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePoolTypes.Get. See the method description for details.

project

Project ID for this request.

Type

str

storage_pool_type

Name of the storage pool type to return.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetSubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

subnetwork

Name of the Subnetwork resource to return.

Type

str

class google.cloud.compute_v1.types.GetTargetGrpcProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetGrpcProxies.Get. See the method description for details.

project

Project ID for this request.

Type

str

target_grpc_proxy

Name of the TargetGrpcProxy resource to return.

Type

str

class google.cloud.compute_v1.types.GetTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpProxies.Get. See the method description for details.

project

Project ID for this request.

Type

str

target_http_proxy

Name of the TargetHttpProxy resource to return.

Type

str

class google.cloud.compute_v1.types.GetTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.Get. See the method description for details.

project

Project ID for this request.

Type

str

target_https_proxy

Name of the TargetHttpsProxy resource to return.

Type

str

class google.cloud.compute_v1.types.GetTargetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetInstances.Get. See the method description for details.

project

Project ID for this request.

Type

str

target_instance

Name of the TargetInstance resource to return.

Type

str

zone

Name of the zone scoping this request.

Type

str

class google.cloud.compute_v1.types.GetTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

target_pool

Name of the TargetPool resource to return.

Type

str

class google.cloud.compute_v1.types.GetTargetSslProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.Get. See the method description for details.

project

Project ID for this request.

Type

str

target_ssl_proxy

Name of the TargetSslProxy resource to return.

Type

str

class google.cloud.compute_v1.types.GetTargetTcpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetTcpProxies.Get. See the method description for details.

project

Project ID for this request.

Type

str

target_tcp_proxy

Name of the TargetTcpProxy resource to return.

Type

str

class google.cloud.compute_v1.types.GetTargetVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetVpnGateways.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

target_vpn_gateway

Name of the target VPN gateway to return.

Type

str

class google.cloud.compute_v1.types.GetUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.Get. See the method description for details.

project

Project ID for this request.

Type

str

url_map

Name of the UrlMap resource to return.

Type

str

class google.cloud.compute_v1.types.GetVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnGateways.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

vpn_gateway

Name of the VPN gateway to return.

Type

str

class google.cloud.compute_v1.types.GetVpnTunnelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnTunnels.Get. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

vpn_tunnel

Name of the VpnTunnel resource to return.

Type

str

class google.cloud.compute_v1.types.GetXpnHostProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.GetXpnHost. See the method description for details.

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.GetXpnResourcesProjectsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.GetXpnResources. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.GetZoneOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ZoneOperations.Get. See the method description for details.

operation

Name of the Operations resource to return, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.GetZoneRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Zones.Get. See the method description for details.

project

Project ID for this request.

Type

str

zone

Name of the zone resource to return.

Type

str

class google.cloud.compute_v1.types.GlobalAddressesMoveRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

description

An optional destination address description if intended to be different from the source.

This field is a member of oneof _description.

Type

str

destination_address

The URL of the destination address to move to. This can be a full or partial URL. For example, the following are all valid URLs to a address: - https://www.googleapis.com/compute/v1/projects/project /global/addresses/address - projects/project/global/addresses/address Note that destination project must be different from the source project. So /global/addresses/address is not valid partial url.

This field is a member of oneof _destination_address.

Type

str

class google.cloud.compute_v1.types.GlobalNetworkEndpointGroupsAttachEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_endpoints

The list of network endpoints to be attached.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpoint]

class google.cloud.compute_v1.types.GlobalNetworkEndpointGroupsDetachEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_endpoints

The list of network endpoints to be detached.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpoint]

class google.cloud.compute_v1.types.GlobalOrganizationSetPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

bindings

Flatten Policy to create a backward compatible wire-format. Deprecated. Use ‘policy’ to specify bindings.

Type

MutableSequence[google.cloud.compute_v1.types.Binding]

etag

Flatten Policy to create a backward compatible wire-format. Deprecated. Use ‘policy’ to specify the etag.

This field is a member of oneof _etag.

Type

str

policy

REQUIRED: The complete policy to be applied to the ‘resource’. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

This field is a member of oneof _policy.

Type

google.cloud.compute_v1.types.Policy

class google.cloud.compute_v1.types.GlobalSetLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

label_fingerprint

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.

This field is a member of oneof _label_fingerprint.

Type

str

labels

A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, “webserver-frontend”: “images”. A label value can also be empty (e.g. “my-label”: “”).

Type

MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.GlobalSetPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

bindings

Flatten Policy to create a backward compatible wire-format. Deprecated. Use ‘policy’ to specify bindings.

Type

MutableSequence[google.cloud.compute_v1.types.Binding]

etag

Flatten Policy to create a backward compatible wire-format. Deprecated. Use ‘policy’ to specify the etag.

This field is a member of oneof _etag.

Type

str

policy

REQUIRED: The complete policy to be applied to the ‘resource’. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

This field is a member of oneof _policy.

Type

google.cloud.compute_v1.types.Policy

class google.cloud.compute_v1.types.GuestAttributes(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A guest attributes entry.

kind

[Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

This field is a member of oneof _kind.

Type

str

query_path

The path to be queried. This can be the default namespace (‘’) or a nested namespace (’/’) or a specified key (’/').

This field is a member of oneof _query_path.

Type

str

query_value

[Output Only] The value of the requested queried path.

This field is a member of oneof _query_value.

Type

google.cloud.compute_v1.types.GuestAttributesValue

self_link

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

This field is a member of oneof _self_link.

Type

str

variable_key

The key to search for.

This field is a member of oneof _variable_key.

Type

str

variable_value

[Output Only] The value found for the requested key.

This field is a member of oneof _variable_value.

Type

str

class google.cloud.compute_v1.types.GuestAttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A guest attributes namespace/key/value entry.

key

Key for the guest attribute entry.

This field is a member of oneof _key.

Type

str

namespace

Namespace for the guest attribute entry.

This field is a member of oneof _namespace.

Type

str

value

Value for the guest attribute entry.

This field is a member of oneof _value.

Type

str

class google.cloud.compute_v1.types.GuestAttributesValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Array of guest attribute namespace/key/value tuples.

items

Type

MutableSequence[google.cloud.compute_v1.types.GuestAttributesEntry]

class google.cloud.compute_v1.types.GuestOsFeature(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Guest OS features.

type_

The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

FEATURE_TYPE_UNSPECIFIED (531767259):

No description available.

GVNIC (68209305):

No description available.

IDPF (2242641):

No description available.

MULTI_IP_SUBNET (151776719):

No description available.

SECURE_BOOT (376811194):

No description available.

SEV_CAPABLE (87083793):

No description available.

SEV_LIVE_MIGRATABLE (392039820):

No description available.

SEV_LIVE_MIGRATABLE_V2 (168551983):

No description available.

SEV_SNP_CAPABLE (426919):

No description available.

TDX_CAPABLE (240446133):

No description available.

UEFI_COMPATIBLE (195865408):

No description available.

VIRTIO_SCSI_MULTIQUEUE (201597069):

No description available.

WINDOWS (456863331):

No description available.

class google.cloud.compute_v1.types.HTTP2HealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

host

The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

This field is a member of oneof _host.

Type

str

port

The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.

This field is a member of oneof _port.

Type

int

port_name

Not supported.

This field is a member of oneof _port_name.

Type

str

port_specification

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Check the PortSpecification enum for the list of possible values.

This field is a member of oneof _port_specification.

Type

str

proxy_header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

request_path

The request path of the HTTP/2 health check request. The default value is /. Must comply with RFC3986.

This field is a member of oneof _request_path.

Type

str

response

Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

This field is a member of oneof _response.

Type

str

class PortSpecification(value)

Bases: proto.enums.Enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports.

Values:

UNDEFINED_PORT_SPECIFICATION (0):

A value indicating that the enum field is not set.

USE_FIXED_PORT (190235748):

The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.

USE_NAMED_PORT (349300671):

Not supported.

USE_SERVING_PORT (362637516):

For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.

class ProxyHeader(value)

Bases: proto.enums.Enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.HTTPHealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

host

The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

This field is a member of oneof _host.

Type

str

port

The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.

This field is a member of oneof _port.

Type

int

port_name

Not supported.

This field is a member of oneof _port_name.

Type

str

port_specification

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Check the PortSpecification enum for the list of possible values.

This field is a member of oneof _port_specification.

Type

str

proxy_header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

request_path

The request path of the HTTP health check request. The default value is /. Must comply with RFC3986.

This field is a member of oneof _request_path.

Type

str

response

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

This field is a member of oneof _response.

Type

str

class PortSpecification(value)

Bases: proto.enums.Enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports.

Values:

UNDEFINED_PORT_SPECIFICATION (0):

A value indicating that the enum field is not set.

USE_FIXED_PORT (190235748):

The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.

USE_NAMED_PORT (349300671):

Not supported.

USE_SERVING_PORT (362637516):

For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.

class ProxyHeader(value)

Bases: proto.enums.Enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.HTTPSHealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

host

The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

This field is a member of oneof _host.

Type

str

port

The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.

This field is a member of oneof _port.

Type

int

port_name

Not supported.

This field is a member of oneof _port_name.

Type

str

port_specification

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Check the PortSpecification enum for the list of possible values.

This field is a member of oneof _port_specification.

Type

str

proxy_header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

request_path

The request path of the HTTPS health check request. The default value is /. Must comply with RFC3986.

This field is a member of oneof _request_path.

Type

str

response

Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

This field is a member of oneof _response.

Type

str

class PortSpecification(value)

Bases: proto.enums.Enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports.

Values:

UNDEFINED_PORT_SPECIFICATION (0):

A value indicating that the enum field is not set.

USE_FIXED_PORT (190235748):

The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.

USE_NAMED_PORT (349300671):

Not supported.

USE_SERVING_PORT (362637516):

For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.

class ProxyHeader(value)

Bases: proto.enums.Enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.HealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a health check resource. Google Compute Engine has two health check resources: * Regional * Global These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). Load balancing Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide. Autohealing in MIGs The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.

check_interval_sec

How often (in seconds) to send a health check. The default value is 5 seconds.

This field is a member of oneof _check_interval_sec.

Type

int

creation_timestamp

[Output Only] Creation timestamp in 3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

grpc_health_check

This field is a member of oneof _grpc_health_check.

Type

google.cloud.compute_v1.types.GRPCHealthCheck

healthy_threshold

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

This field is a member of oneof _healthy_threshold.

Type

int

http2_health_check

This field is a member of oneof _http2_health_check.

Type

google.cloud.compute_v1.types.HTTP2HealthCheck

http_health_check

This field is a member of oneof _http_health_check.

Type

google.cloud.compute_v1.types.HTTPHealthCheck

https_health_check

This field is a member of oneof _https_health_check.

Type

google.cloud.compute_v1.types.HTTPSHealthCheck

id

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

This field is a member of oneof _id.

Type

int

kind

Type of the resource.

This field is a member of oneof _kind.

Type

str

log_config

Configure logging on this health check.

This field is a member of oneof _log_config.

Type

google.cloud.compute_v1.types.HealthCheckLogConfig

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. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn’t a dash.

This field is a member of oneof _name.

Type

str

region

[Output Only] Region where the health check resides. Not applicable to global health checks.

This field is a member of oneof _region.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

source_regions

The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.

Type

MutableSequence[str]

ssl_health_check

This field is a member of oneof _ssl_health_check.

Type

google.cloud.compute_v1.types.SSLHealthCheck

tcp_health_check

This field is a member of oneof _tcp_health_check.

Type

google.cloud.compute_v1.types.TCPHealthCheck

timeout_sec

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.

This field is a member of oneof _timeout_sec.

Type

int

type_

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

unhealthy_threshold

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

This field is a member of oneof _unhealthy_threshold.

Type

int

class Type(value)

Bases: proto.enums.Enum

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

GRPC (2196510):

No description available.

HTTP (2228360):

No description available.

HTTP2 (69079210):

No description available.

HTTPS (69079243):

No description available.

INVALID (530283991):

No description available.

SSL (82412):

No description available.

TCP (82881):

No description available.

class google.cloud.compute_v1.types.HealthCheckList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of HealthCheck resources.

id

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

This field is a member of oneof _id.

Type

str

items

A list of HealthCheck resources.

Type

MutableSequence[google.cloud.compute_v1.types.HealthCheck]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.HealthCheckLogConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.

enable

Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

This field is a member of oneof _enable.

Type

bool

class google.cloud.compute_v1.types.HealthCheckReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check

health_check

This field is a member of oneof _health_check.

Type

str

class google.cloud.compute_v1.types.HealthCheckService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Health-Check as a Service resource.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

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

This field is a member of oneof _description.

Type

str

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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.

This field is a member of oneof _fingerprint.

Type

str

health_checks

A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.

Type

MutableSequence[str]

health_status_aggregation_policy

Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. Check the HealthStatusAggregationPolicy enum for the list of possible values.

This field is a member of oneof _health_status_aggregation_policy.

Type

str

id

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

This field is a member of oneof _id.

Type

int

kind

[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

network_endpoint_groups

A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.

Type

MutableSequence[str]

notification_endpoints

A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.

Type

MutableSequence[str]

region

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

This field is a member of oneof _region.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

class HealthStatusAggregationPolicy(value)

Bases: proto.enums.Enum

Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService.

Values:

UNDEFINED_HEALTH_STATUS_AGGREGATION_POLICY (0):

A value indicating that the enum field is not set.

AND (64951):

If any backend’s health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend’s are healthy, the HealthState of the health check service is HEALTHY.

NO_AGGREGATION (426445124):

An EndpointHealth message is returned for each backend in the health check service.

class google.cloud.compute_v1.types.HealthCheckServiceReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service

health_check_service

This field is a member of oneof _health_check_service.

Type

str

class google.cloud.compute_v1.types.HealthCheckServicesList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of HealthCheckService resources.

Type

MutableSequence[google.cloud.compute_v1.types.HealthCheckService]

kind

[Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.HealthChecksAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

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

This field is a member of oneof _id.

Type

str

items

A list of HealthChecksScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.HealthChecksScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.HealthChecksScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

health_checks

A list of HealthChecks contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.HealthCheck]

warning

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

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.HealthStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

annotations

Metadata defined as annotations for network endpoint.

Type

MutableMapping[str, str]

forwarding_rule

URL of the forwarding rule associated with the health status of the instance.

This field is a member of oneof _forwarding_rule.

Type

str

forwarding_rule_ip

A forwarding rule IP address assigned to this instance.

This field is a member of oneof _forwarding_rule_ip.

Type

str

health_state

Health state of the IPv4 address of the instance. Check the HealthState enum for the list of possible values.

This field is a member of oneof _health_state.

Type

str

instance

URL of the instance resource.

This field is a member of oneof _instance.

Type

str

ip_address

For target pool based Network Load Balancing, it indicates the forwarding rule’s IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.

This field is a member of oneof _ip_address.

Type

str

ipv6_address

This field is a member of oneof _ipv6_address.

Type

str

ipv6_health_state

Health state of the IPv6 address of the instance. Check the Ipv6HealthState enum for the list of possible values.

This field is a member of oneof _ipv6_health_state.

Type

str

port

The named port of the instance group, not necessarily the port that is health-checked.

This field is a member of oneof _port.

Type

int

weight

This field is a member of oneof _weight.

Type

str

weight_error

Check the WeightError enum for the list of possible values.

This field is a member of oneof _weight_error.

Type

str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class HealthState(value)

Bases: proto.enums.Enum

Health state of the IPv4 address of the instance. Additional supported values which may be not listed in the enum directly due to technical reasons:

HEALTHY UNHEALTHY

Values:

UNDEFINED_HEALTH_STATE (0):

A value indicating that the enum field is not set.

HEALTHY (439801213):

No description available.

UNHEALTHY (462118084):

No description available.

class Ipv6HealthState(value)

Bases: proto.enums.Enum

Health state of the IPv6 address of the instance. Additional supported values which may be not listed in the enum directly due to technical reasons:

HEALTHY UNHEALTHY

Values:

UNDEFINED_IPV6_HEALTH_STATE (0):

A value indicating that the enum field is not set.

class WeightError(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_WEIGHT_ERROR (0):

A value indicating that the enum field is not set.

INVALID_WEIGHT (383698400):

The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).

MISSING_WEIGHT (384027537):

The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.

UNAVAILABLE_WEIGHT (439464295):

This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.

WEIGHT_NONE (502428831):

This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight.

class google.cloud.compute_v1.types.HealthStatusForNetworkEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

backend_service

URL of the backend service associated with the health state of the network endpoint.

This field is a member of oneof _backend_service.

Type

google.cloud.compute_v1.types.BackendServiceReference

forwarding_rule

URL of the forwarding rule associated with the health state of the network endpoint.

This field is a member of oneof _forwarding_rule.

Type

google.cloud.compute_v1.types.ForwardingRuleReference

health_check

URL of the health check associated with the health state of the network endpoint.

This field is a member of oneof _health_check.

Type

google.cloud.compute_v1.types.HealthCheckReference

health_check_service

URL of the health check service associated with the health state of the network endpoint.

This field is a member of oneof _health_check_service.

Type

google.cloud.compute_v1.types.HealthCheckServiceReference

health_state

Health state of the network endpoint determined based on the health checks configured. Check the HealthState enum for the list of possible values.

This field is a member of oneof _health_state.

Type

str

ipv6_health_state

Health state of the ipv6 network endpoint determined based on the health checks configured. Check the Ipv6HealthState enum for the list of possible values.

This field is a member of oneof _ipv6_health_state.

Type

str

class HealthState(value)

Bases: proto.enums.Enum

Health state of the network endpoint determined based on the health checks configured. Additional supported values which may be not listed in the enum directly due to technical reasons:

DRAINING HEALTHY UNHEALTHY UNKNOWN

Values:

UNDEFINED_HEALTH_STATE (0):

A value indicating that the enum field is not set.

DRAINING (480455402):

No description available.

HEALTHY (439801213):

No description available.

UNHEALTHY (462118084):

No description available.

UNKNOWN (433141802):

No description available.

class Ipv6HealthState(value)

Bases: proto.enums.Enum

Health state of the ipv6 network endpoint determined based on the health checks configured. Additional supported values which may be not listed in the enum directly due to technical reasons:

DRAINING HEALTHY UNHEALTHY UNKNOWN

Values:

UNDEFINED_IPV6_HEALTH_STATE (0):

A value indicating that the enum field is not set.

class google.cloud.compute_v1.types.Help(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn’t enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

links

URL(s) pointing to additional information on handling the current error.

Type

MutableSequence[google.cloud.compute_v1.types.HelpLink]

class google.cloud.compute_v1.types.HelpLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes a URL link.

description

Describes what the link offers.

This field is a member of oneof _description.

Type

str

url

The URL of the link.

This field is a member of oneof _url.

Type

str

class google.cloud.compute_v1.types.HostRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

description

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

This field is a member of oneof _description.

Type

str

hosts

The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

Type

MutableSequence[str]

path_matcher

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

This field is a member of oneof _path_matcher.

Type

str

class google.cloud.compute_v1.types.HttpFaultAbort(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specification for how requests are aborted as part of fault injection.

http_status

The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

This field is a member of oneof _http_status.

Type

int

percentage

The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.

This field is a member of oneof _percentage.

Type

float

class google.cloud.compute_v1.types.HttpFaultDelay(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.

fixed_delay

Specifies the value of the fixed delay interval.

This field is a member of oneof _fixed_delay.

Type

google.cloud.compute_v1.types.Duration

percentage

The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.

This field is a member of oneof _percentage.

Type

float

class google.cloud.compute_v1.types.HttpFaultInjection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.

abort

The specification for how client requests are aborted as part of fault injection.

This field is a member of oneof _abort.

Type

google.cloud.compute_v1.types.HttpFaultAbort

delay

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

This field is a member of oneof _delay.

Type

google.cloud.compute_v1.types.HttpFaultDelay

class google.cloud.compute_v1.types.HttpHeaderAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request and response header transformations that take effect before the request is passed along to the selected backendService.

request_headers_to_add

Headers to add to a matching request before forwarding the request to the backendService.

Type

MutableSequence[google.cloud.compute_v1.types.HttpHeaderOption]

request_headers_to_remove

A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.

Type

MutableSequence[str]

response_headers_to_add

Headers to add the response before sending the response back to the client.

Type

MutableSequence[google.cloud.compute_v1.types.HttpHeaderOption]

response_headers_to_remove

A list of header names for headers that need to be removed from the response before sending the response back to the client.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.HttpHeaderMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

matchRule criteria for request header matches.

exact_match

The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

This field is a member of oneof _exact_match.

Type

str

header_name

The name of the HTTP header to match. For matching against the HTTP request’s authority, use a headerMatch with the header name “:authority”. For matching a request’s method, use the headerName “:method”. When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the content-type header are supported. The following transport-level headers cannot be used in header matching rules: :authority, :method, :path, :scheme, user-agent, accept-encoding, content-encoding, grpc-accept-encoding, grpc-encoding, grpc-previous-rpc-attempts, grpc-tags-bin, grpc-timeout and grpc-trace-bin.

This field is a member of oneof _header_name.

Type

str

invert_match

If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false.

This field is a member of oneof _invert_match.

Type

bool

prefix_match

The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

This field is a member of oneof _prefix_match.

Type

str

present_match

A header with the contents of headerName must exist. The match takes place whether or not the request’s header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

This field is a member of oneof _present_match.

Type

bool

range_match

The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL.

This field is a member of oneof _range_match.

Type

google.cloud.compute_v1.types.Int64RangeMatch

regex_match

The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header’s port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

This field is a member of oneof _regex_match.

Type

str

suffix_match

The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

This field is a member of oneof _suffix_match.

Type

str

class google.cloud.compute_v1.types.HttpHeaderOption(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specification determining how headers are added to requests or responses.

header_name

The name of the header.

This field is a member of oneof _header_name.

Type

str

header_value

The value of the header to add.

This field is a member of oneof _header_value.

Type

str

replace

If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

This field is a member of oneof _replace.

Type

bool

class google.cloud.compute_v1.types.HttpQueryParameterMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

HttpRouteRuleMatch criteria for a request’s query parameter.

exact_match

The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch, or regexMatch must be set.

This field is a member of oneof _exact_match.

Type

str

name

The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

This field is a member of oneof _name.

Type

str

present_match

Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch, or regexMatch must be set.

This field is a member of oneof _present_match.

Type

bool

regex_match

The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For more information about regular expression syntax, see Syntax. Only one of presentMatch, exactMatch, or regexMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

This field is a member of oneof _regex_match.

Type

str

class google.cloud.compute_v1.types.HttpRedirectAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specifies settings for an HTTP redirect.

host_redirect

The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.

This field is a member of oneof _host_redirect.

Type

str

https_redirect

If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

This field is a member of oneof _https_redirect.

Type

bool

path_redirect

The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.

This field is a member of oneof _path_redirect.

Type

str

prefix_redirect

The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.

This field is a member of oneof _prefix_redirect.

Type

str

redirect_response_code

The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained. Check the RedirectResponseCode enum for the list of possible values.

This field is a member of oneof _redirect_response_code.

Type

str

strip_query

If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.

This field is a member of oneof _strip_query.

Type

bool

class RedirectResponseCode(value)

Bases: proto.enums.Enum

The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.

Values:

UNDEFINED_REDIRECT_RESPONSE_CODE (0):

A value indicating that the enum field is not set.

FOUND (67084130):

Http Status Code 302 - Found.

MOVED_PERMANENTLY_DEFAULT (386698449):

Http Status Code 301 - Moved Permanently.

PERMANENT_REDIRECT (382006381):

Http Status Code 308 - Permanent Redirect maintaining HTTP method.

SEE_OTHER (445380580):

Http Status Code 303 - See Other.

TEMPORARY_REDIRECT (489550378):

Http Status Code 307 - Temporary Redirect maintaining HTTP method.

class google.cloud.compute_v1.types.HttpRetryPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The retry policy associates with HttpRouteRule

num_retries

Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

This field is a member of oneof _num_retries.

Type

int

per_try_timeout

Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the HttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

This field is a member of oneof _per_try_timeout.

Type

google.cloud.compute_v1.types.Duration

retry_conditions

Specifies one or more conditions when this retry policy applies. Valid values are: - 5xx: retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - connect-failure: a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts. - retriable-4xx: a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409. - refused-stream: a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: a retry is attempted if the gRPC status code in the response header is set to cancelled. - deadline-exceeded: a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded. - internal: a retry is attempted if the gRPC status code in the response header is set to internal. - resource-exhausted: a retry is attempted if the gRPC status code in the response header is set to resource-exhausted. - unavailable: a retry is attempted if the gRPC status code in the response header is set to unavailable. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true. - cancelled - deadline-exceeded - internal - resource-exhausted - unavailable

Type

MutableSequence[str]

class google.cloud.compute_v1.types.HttpRouteAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

cors_policy

The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy.

This field is a member of oneof _cors_policy.

Type

google.cloud.compute_v1.types.CorsPolicy

fault_injection_policy

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the classic Application Load Balancer . To see which load balancers support fault injection, see Load balancing: Routing and traffic management features.

This field is a member of oneof _fault_injection_policy.

Type

google.cloud.compute_v1.types.HttpFaultInjection

max_stream_duration

Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

This field is a member of oneof _max_stream_duration.

Type

google.cloud.compute_v1.types.Duration

request_mirror_policy

Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

This field is a member of oneof _request_mirror_policy.

Type

google.cloud.compute_v1.types.RequestMirrorPolicy

retry_policy

Specifies the retry policy associated with this route.

This field is a member of oneof _retry_policy.

Type

google.cloud.compute_v1.types.HttpRetryPolicy

timeout

Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

This field is a member of oneof _timeout.

Type

google.cloud.compute_v1.types.Duration

url_rewrite

The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for classic Application Load Balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

This field is a member of oneof _url_rewrite.

Type

google.cloud.compute_v1.types.UrlRewrite

weighted_backend_services

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Type

MutableSequence[google.cloud.compute_v1.types.WeightedBackendService]

class google.cloud.compute_v1.types.HttpRouteRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.

custom_error_response_policy

customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the RouteRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher’s policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with routeRules.routeAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the customErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the customErrorResponsePolicy is ignored and the response from the service is returned to the client. customErrorResponsePolicy is supported only for global external Application Load Balancers.

This field is a member of oneof _custom_error_response_policy.

Type

google.cloud.compute_v1.types.CustomErrorResponsePolicy

description

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

This field is a member of oneof _description.

Type

str

header_action

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

This field is a member of oneof _header_action.

Type

google.cloud.compute_v1.types.HttpHeaderAction

match_rules

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

Type

MutableSequence[google.cloud.compute_v1.types.HttpRouteRuleMatch]

priority

For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

This field is a member of oneof _priority.

Type

int

route_action

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule’s routeAction.

This field is a member of oneof _route_action.

Type

google.cloud.compute_v1.types.HttpRouteAction

service

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

This field is a member of oneof _service.

Type

str

url_redirect

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

This field is a member of oneof _url_redirect.

Type

google.cloud.compute_v1.types.HttpRedirectAction

class google.cloud.compute_v1.types.HttpRouteRuleMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

full_path_match

For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

This field is a member of oneof _full_path_match.

Type

str

header_matches

Specifies a list of header match criteria, all of which must match corresponding headers in the request.

Type

MutableSequence[google.cloud.compute_v1.types.HttpHeaderMatch]

ignore_case

Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.

This field is a member of oneof _ignore_case.

Type

bool

metadata_filters

Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Type

MutableSequence[google.cloud.compute_v1.types.MetadataFilter]

path_template_match

If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash (“/”) - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.

This field is a member of oneof _path_template_match.

Type

str

prefix_match

For satisfying the matchRule condition, the request’s path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

This field is a member of oneof _prefix_match.

Type

str

query_parameter_matches

Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.

Type

MutableSequence[google.cloud.compute_v1.types.HttpQueryParameterMatch]

regex_match

For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

This field is a member of oneof _regex_match.

Type

str

class google.cloud.compute_v1.types.Image(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

architecture

The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

This field is a member of oneof _architecture.

Type

str

archive_size_bytes

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

This field is a member of oneof _archive_size_bytes.

Type

int

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

deprecated

The deprecation status associated with this image.

This field is a member of oneof _deprecated.

Type

google.cloud.compute_v1.types.DeprecationStatus

description

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

This field is a member of oneof _description.

Type

str

disk_size_gb

Size of the image when restored onto a persistent disk (in GB).

This field is a member of oneof _disk_size_gb.

Type

int

enable_confidential_compute

Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

This field is a member of oneof _enable_confidential_compute.

Type

bool

family

The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

This field is a member of oneof _family.

Type

str

guest_os_features

A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.

Type

MutableSequence[google.cloud.compute_v1.types.GuestOsFeature]

id

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

This field is a member of oneof _id.

Type

int

image_encryption_key

Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

This field is a member of oneof _image_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

kind

[Output Only] Type of the resource. Always compute#image for images.

This field is a member of oneof _kind.

Type

str

label_fingerprint

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

This field is a member of oneof _label_fingerprint.

Type

str

labels

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

Type

MutableMapping[str, str]

license_codes

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

Type

MutableSequence[int]

licenses

Any applicable license URI.

Type

MutableSequence[str]

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.

This field is a member of oneof _name.

Type

str

raw_disk

The parameters of the raw disk image.

This field is a member of oneof _raw_disk.

Type

google.cloud.compute_v1.types.RawDisk

satisfies_pzi

Output only. Reserved for future use.

This field is a member of oneof _satisfies_pzi.

Type

bool

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

self_link

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

This field is a member of oneof _self_link.

Type

str

shielded_instance_initial_state

Set the secure boot keys of shielded instance.

This field is a member of oneof _shielded_instance_initial_state.

Type

google.cloud.compute_v1.types.InitialStateConfig

source_disk

URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

This field is a member of oneof _source_disk.

Type

str

source_disk_encryption_key

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

This field is a member of oneof _source_disk_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_disk_id

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

This field is a member of oneof _source_disk_id.

Type

str

source_image

URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

This field is a member of oneof _source_image.

Type

str

source_image_encryption_key

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

This field is a member of oneof _source_image_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_image_id

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

This field is a member of oneof _source_image_id.

Type

str

source_snapshot

URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

This field is a member of oneof _source_snapshot.

Type

str

source_snapshot_encryption_key

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

This field is a member of oneof _source_snapshot_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_snapshot_id

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

This field is a member of oneof _source_snapshot_id.

Type

str

source_type

The type of the image used to create this disk. The default and only valid value is RAW. Check the SourceType enum for the list of possible values.

This field is a member of oneof _source_type.

Type

str

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. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

storage_locations

Cloud Storage bucket storage location of the image (regional or multi-regional).

Type

MutableSequence[str]

class Architecture(value)

Bases: proto.enums.Enum

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

Values:

UNDEFINED_ARCHITECTURE (0):

A value indicating that the enum field is not set.

ARCHITECTURE_UNSPECIFIED (394750507):

Default value indicating Architecture is not set.

ARM64 (62547450):

Machines with architecture ARM64

X86_64 (425300551):

Machines with architecture X86_64

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class SourceType(value)

Bases: proto.enums.Enum

The type of the image used to create this disk. The default and only valid value is RAW.

Values:

UNDEFINED_SOURCE_TYPE (0):

A value indicating that the enum field is not set.

RAW (80904):

No description available.

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

DELETING (528602024):

Image is deleting.

FAILED (455706685):

Image creation failed due to an error.

PENDING (35394935):

Image hasn’t been created as yet.

READY (77848963):

Image has been successfully created.

class google.cloud.compute_v1.types.ImageFamilyView(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

image

The latest image that is part of the specified image family in the requested location, and that is not deprecated.

This field is a member of oneof _image.

Type

google.cloud.compute_v1.types.Image

class google.cloud.compute_v1.types.ImageList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of images.

id

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

This field is a member of oneof _id.

Type

str

items

A list of Image resources.

Type

MutableSequence[google.cloud.compute_v1.types.Image]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

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

This field is a member of oneof _next_page_token.

Type

str

self_link

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

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InitialStateConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Initial State for shielded instance, these are public keys which are safe to store in public

dbs

The Key Database (db).

Type

MutableSequence[google.cloud.compute_v1.types.FileContentBuffer]

dbxs

The forbidden key database (dbx).

Type

MutableSequence[google.cloud.compute_v1.types.FileContentBuffer]

keks

The Key Exchange Key (KEK).

Type

MutableSequence[google.cloud.compute_v1.types.FileContentBuffer]

pk

The Platform Key (PK).

This field is a member of oneof _pk.

Type

google.cloud.compute_v1.types.FileContentBuffer

class google.cloud.compute_v1.types.InsertAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Addresses.Insert. See the method description for details.

address_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Address

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Autoscalers.Insert. See the method description for details.

autoscaler_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Autoscaler

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.InsertBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.Insert. See the method description for details.

backend_bucket_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendBucket

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.Insert. See the method description for details.

backend_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendService

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.Insert. See the method description for details.

disk_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Disk

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

source_image

Source image to restore onto a disk. This field is optional.

This field is a member of oneof _source_image.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.InsertExternalVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ExternalVpnGateways.Insert. See the method description for details.

external_vpn_gateway_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ExternalVpnGateway

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.Insert. See the method description for details.

firewall_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicy

parent_id

Parent ID for this request. The ID can be either be “folders/[FOLDER_ID]” if the parent is a folder or “organizations/[ORGANIZATION_ID]” if the parent is an organization.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertFirewallRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Firewalls.Insert. See the method description for details.

firewall_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Firewall

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ForwardingRules.Insert. See the method description for details.

forwarding_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ForwardingRule

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertGlobalAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalAddresses.Insert. See the method description for details.

address_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Address

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertGlobalForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalForwardingRules.Insert. See the method description for details.

forwarding_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ForwardingRule

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertGlobalNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalNetworkEndpointGroups.Insert. See the method description for details.

network_endpoint_group_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkEndpointGroup

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertGlobalPublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalPublicDelegatedPrefixes.Insert. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix_resource

The body resource for this request

Type

google.cloud.compute_v1.types.PublicDelegatedPrefix

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for HealthChecks.Insert. See the method description for details.

health_check_resource

The body resource for this request

Type

google.cloud.compute_v1.types.HealthCheck

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.Insert. See the method description for details.

force_create

Force image creation if true.

This field is a member of oneof _force_create.

Type

bool

image_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Image

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.Insert. See the method description for details.

instance_group_manager_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManager

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where you want to create the managed instance group.

Type

str

class google.cloud.compute_v1.types.InsertInstanceGroupManagerResizeRequestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagerResizeRequests.Insert. See the method description for details.

instance_group_manager

The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.

Type

str

instance_group_manager_resize_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagerResizeRequest

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.InsertInstanceGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.Insert. See the method description for details.

instance_group_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroup

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where you want to create the instance group.

Type

str

class google.cloud.compute_v1.types.InsertInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Insert. See the method description for details.

instance_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Instance

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

source_instance_template

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

This field is a member of oneof _source_instance_template.

Type

str

source_machine_image

Specifies the machine image to use 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 a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage

This field is a member of oneof _source_machine_image.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.InsertInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceTemplates.Insert. See the method description for details.

instance_template_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceTemplate

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.Insert. See the method description for details.

instant_snapshot_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstantSnapshot

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.InsertInterconnectAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectAttachments.Insert. See the method description for details.

interconnect_attachment_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InterconnectAttachment

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

validate_only

If true, the request will not be committed.

This field is a member of oneof _validate_only.

Type

bool

class google.cloud.compute_v1.types.InsertInterconnectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Interconnects.Insert. See the method description for details.

interconnect_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Interconnect

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Licenses.Insert. See the method description for details.

license_resource

The body resource for this request

Type

google.cloud.compute_v1.types.License

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertMachineImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineImages.Insert. See the method description for details.

machine_image_resource

The body resource for this request

Type

google.cloud.compute_v1.types.MachineImage

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

source_instance

Required. Source instance that is used to create the machine image from.

This field is a member of oneof _source_instance.

Type

str

class google.cloud.compute_v1.types.InsertNetworkAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.Insert. See the method description for details.

network_attachment_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkAttachment

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

request_id

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). end_interface: MixerMutationRequestBuilder

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertNetworkEdgeSecurityServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEdgeSecurityServices.Insert. See the method description for details.

network_edge_security_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkEdgeSecurityService

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

validate_only

If true, the request will not be committed.

This field is a member of oneof _validate_only.

Type

bool

class google.cloud.compute_v1.types.InsertNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.Insert. See the method description for details.

network_endpoint_group_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkEndpointGroup

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.

Type

str

class google.cloud.compute_v1.types.InsertNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.Insert. See the method description for details.

firewall_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicy

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.Insert. See the method description for details.

network_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Network

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.Insert. See the method description for details.

initial_node_count

Initial count of nodes in the node group.

Type

int

node_group_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NodeGroup

project

Project ID for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.InsertNodeTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTemplates.Insert. See the method description for details.

node_template_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NodeTemplate

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertPacketMirroringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PacketMirrorings.Insert. See the method description for details.

packet_mirroring_resource

The body resource for this request

Type

google.cloud.compute_v1.types.PacketMirroring

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertPublicAdvertisedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicAdvertisedPrefixes.Insert. See the method description for details.

project

Project ID for this request.

Type

str

public_advertised_prefix_resource

The body resource for this request

Type

google.cloud.compute_v1.types.PublicAdvertisedPrefix

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertPublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicDelegatedPrefixes.Insert. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix_resource

The body resource for this request

Type

google.cloud.compute_v1.types.PublicDelegatedPrefix

region

Name of the region of this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionAutoscalers.Insert. See the method description for details.

autoscaler_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Autoscaler

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.Insert. See the method description for details.

backend_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendService

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionCommitmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionCommitments.Insert. See the method description for details.

commitment_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Commitment

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.Insert. See the method description for details.

disk_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Disk

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

source_image

Source image to restore onto a disk. This field is optional.

This field is a member of oneof _source_image.

Type

str

class google.cloud.compute_v1.types.InsertRegionHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthChecks.Insert. See the method description for details.

health_check_resource

The body resource for this request

Type

google.cloud.compute_v1.types.HealthCheck

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionHealthCheckServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthCheckServices.Insert. See the method description for details.

health_check_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.HealthCheckService

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.Insert. See the method description for details.

instance_group_manager_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManager

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceTemplates.Insert. See the method description for details.

instance_template_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceTemplate

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstantSnapshots.Insert. See the method description for details.

instant_snapshot_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstantSnapshot

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkEndpointGroups.Insert. See the method description for details.

network_endpoint_group_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkEndpointGroup

project

Project ID for this request.

Type

str

region

The name of the region where you want to create the network endpoint group. It should comply with RFC1035.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.Insert. See the method description for details.

firewall_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicy

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionNotificationEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNotificationEndpoints.Insert. See the method description for details.

notification_endpoint_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NotificationEndpoint

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.InsertRegionSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicy

validate_only

If true, the request will not be committed.

This field is a member of oneof _validate_only.

Type

bool

class google.cloud.compute_v1.types.InsertRegionSslCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslCertificates.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

ssl_certificate_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SslCertificate

class google.cloud.compute_v1.types.InsertRegionSslPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslPolicies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

ssl_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SslPolicy

class google.cloud.compute_v1.types.InsertRegionTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpProxies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_http_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpProxy

class google.cloud.compute_v1.types.InsertRegionTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpsProxies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpsProxy

class google.cloud.compute_v1.types.InsertRegionTargetTcpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetTcpProxies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_tcp_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetTcpProxy

class google.cloud.compute_v1.types.InsertRegionUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionUrlMaps.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

This field is a member of oneof _request_id.

Type

str

url_map_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMap

class google.cloud.compute_v1.types.InsertReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

reservation_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Reservation

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.InsertResourcePolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ResourcePolicy

class google.cloud.compute_v1.types.InsertRouteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routes.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

route_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Route

class google.cloud.compute_v1.types.InsertRouterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

router_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Router

class google.cloud.compute_v1.types.InsertSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicy

validate_only

If true, the request will not be committed.

This field is a member of oneof _validate_only.

Type

bool

class google.cloud.compute_v1.types.InsertServiceAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

service_attachment_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ServiceAttachment

class google.cloud.compute_v1.types.InsertSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Snapshots.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

snapshot_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Snapshot

class google.cloud.compute_v1.types.InsertSslCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslCertificates.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

ssl_certificate_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SslCertificate

class google.cloud.compute_v1.types.InsertSslPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslPolicies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

ssl_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SslPolicy

class google.cloud.compute_v1.types.InsertStoragePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

storage_pool_resource

The body resource for this request

Type

google.cloud.compute_v1.types.StoragePool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.InsertSubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

subnetwork_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Subnetwork

class google.cloud.compute_v1.types.InsertTargetGrpcProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetGrpcProxies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_grpc_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetGrpcProxy

class google.cloud.compute_v1.types.InsertTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpProxies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_http_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpProxy

class google.cloud.compute_v1.types.InsertTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpsProxy

class google.cloud.compute_v1.types.InsertTargetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetInstances.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_instance_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetInstance

zone

Name of the zone scoping this request.

Type

str

class google.cloud.compute_v1.types.InsertTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_pool_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetPool

class google.cloud.compute_v1.types.InsertTargetSslProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_ssl_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetSslProxy

class google.cloud.compute_v1.types.InsertTargetTcpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetTcpProxies.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_tcp_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetTcpProxy

class google.cloud.compute_v1.types.InsertTargetVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetVpnGateways.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_vpn_gateway_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetVpnGateway

class google.cloud.compute_v1.types.InsertUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.Insert. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

url_map_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMap

class google.cloud.compute_v1.types.InsertVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnGateways.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

vpn_gateway_resource

The body resource for this request

Type

google.cloud.compute_v1.types.VpnGateway

class google.cloud.compute_v1.types.InsertVpnTunnelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnTunnels.Insert. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

vpn_tunnel_resource

The body resource for this request

Type

google.cloud.compute_v1.types.VpnTunnel

class google.cloud.compute_v1.types.Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

advanced_machine_features

Controls for advanced machine-related behavior features.

This field is a member of oneof _advanced_machine_features.

Type

google.cloud.compute_v1.types.AdvancedMachineFeatures

can_ip_forward

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 .

This field is a member of oneof _can_ip_forward.

Type

bool

confidential_instance_config

This field is a member of oneof _confidential_instance_config.

Type

google.cloud.compute_v1.types.ConfidentialInstanceConfig

cpu_platform

[Output Only] The CPU platform used by this instance.

This field is a member of oneof _cpu_platform.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

deletion_protection

Whether the resource should be protected against deletion.

This field is a member of oneof _deletion_protection.

Type

bool

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

disks

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Type

MutableSequence[google.cloud.compute_v1.types.AttachedDisk]

display_device

Enables display device for the instance.

This field is a member of oneof _display_device.

Type

google.cloud.compute_v1.types.DisplayDevice

fingerprint

Specifies a fingerprint for this resource, which is essentially a hash of the instance’s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.

This field is a member of oneof _fingerprint.

Type

str

guest_accelerators

A list of the type and count of accelerator cards attached to the instance.

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorConfig]

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.

This field is a member of oneof _hostname.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

instance_encryption_key

Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.

This field is a member of oneof _instance_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

key_revocation_action_type

KeyRevocationActionType of the instance. Supported options are “STOP” and “NONE”. The default value is “NONE” if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.

This field is a member of oneof _key_revocation_action_type.

Type

str

kind

[Output Only] Type of the resource. Always compute#instance for instances.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for this request, which is essentially a hash of the label’s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels to apply to this instance. These can be later modified by the setLabels method.

Type

MutableMapping[str, str]

last_start_timestamp

[Output Only] Last start timestamp in RFC3339 text format.

This field is a member of oneof _last_start_timestamp.

Type

str

last_stop_timestamp

[Output Only] Last stop timestamp in RFC3339 text format.

This field is a member of oneof _last_stop_timestamp.

Type

str

last_suspended_timestamp

[Output Only] Last suspended timestamp in RFC3339 text format.

This field is a member of oneof _last_suspended_timestamp.

Type

str

machine_type

Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, … 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

This field is a member of oneof _machine_type.

Type

str

metadata

The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

This field is a member of oneof _metadata.

Type

google.cloud.compute_v1.types.Metadata

min_cpu_platform

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”.

This field is a member of oneof _min_cpu_platform.

Type

str

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.

This field is a member of oneof _name.

Type

str

network_interfaces

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkInterface]

network_performance_config

This field is a member of oneof _network_performance_config.

Type

google.cloud.compute_v1.types.NetworkPerformanceConfig

params

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

This field is a member of oneof _params.

Type

google.cloud.compute_v1.types.InstanceParams

private_ipv6_google_access

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

This field is a member of oneof _private_ipv6_google_access.

Type

str

reservation_affinity

Specifies the reservations that this instance can consume from.

This field is a member of oneof _reservation_affinity.

Type

google.cloud.compute_v1.types.ReservationAffinity

resource_policies

Resource policies applied to this instance.

Type

MutableSequence[str]

resource_status

[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

This field is a member of oneof _resource_status.

Type

google.cloud.compute_v1.types.ResourceStatus

satisfies_pzi

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzi.

Type

bool

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

scheduling

Sets the scheduling options for this instance.

This field is a member of oneof _scheduling.

Type

google.cloud.compute_v1.types.Scheduling

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

service_accounts

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

Type

MutableSequence[google.cloud.compute_v1.types.ServiceAccount]

shielded_instance_config

This field is a member of oneof _shielded_instance_config.

Type

google.cloud.compute_v1.types.ShieldedInstanceConfig

shielded_instance_integrity_policy

This field is a member of oneof _shielded_instance_integrity_policy.

Type

google.cloud.compute_v1.types.ShieldedInstanceIntegrityPolicy

source_machine_image

Source machine image

This field is a member of oneof _source_machine_image.

Type

str

source_machine_image_encryption_key

Source machine image encryption key when creating an instance from a machine image.

This field is a member of oneof _source_machine_image_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

start_restricted

[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

This field is a member of oneof _start_restricted.

Type

bool

status

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

status_message

[Output Only] An optional, human-readable explanation of the status.

This field is a member of oneof _status_message.

Type

str

tags

Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the ‘tags.items’ field.

This field is a member of oneof _tags.

Type

google.cloud.compute_v1.types.Tags

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.

This field is a member of oneof _zone.

Type

str

class KeyRevocationActionType(value)

Bases: proto.enums.Enum

KeyRevocationActionType of the instance. Supported options are “STOP” and “NONE”. The default value is “NONE” if it is not specified.

Values:

UNDEFINED_KEY_REVOCATION_ACTION_TYPE (0):

A value indicating that the enum field is not set.

KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED (467110106):

Default value. This value is unused.

NONE (2402104):

Indicates user chose no operation.

STOP (2555906):

Indicates user chose to opt for VM shutdown on key revocation.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class PrivateIpv6GoogleAccess(value)

Bases: proto.enums.Enum

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

Values:

UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS (0):

A value indicating that the enum field is not set.

ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE (427975994):

Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance’s default network interface will be assigned an internal IPv6 prefix if it doesn’t have before.

ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE (288210263):

Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance’s default network interface will be assigned an internal IPv6 prefix if it doesn’t have before.

INHERIT_FROM_SUBNETWORK (530256959):

Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

DEPROVISIONING (428935662):

The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.

PROVISIONING (290896621):

Resources are being allocated for the instance.

REPAIRING (413483285):

The instance is in repair.

RUNNING (121282975):

The instance is running.

STAGING (431072283):

All required resources have been allocated and the instance is being started.

STOPPED (444276141):

The instance has stopped successfully.

STOPPING (350791796):

The instance is currently stopping (either being deleted or killed).

SUSPENDED (51223995):

The instance has suspended.

SUSPENDING (514206246):

The instance is suspending.

TERMINATED (250018339):

The instance has stopped (either by explicit action or underlying failure).

class google.cloud.compute_v1.types.InstanceAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

An object that contains a list of instances scoped by zone.

Type

MutableMapping[str, google.cloud.compute_v1.types.InstancesScopedList]

kind

[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstanceConsumptionData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

consumption_info

Resources consumed by the instance.

This field is a member of oneof _consumption_info.

Type

google.cloud.compute_v1.types.InstanceConsumptionInfo

instance

Server-defined URL for the instance.

This field is a member of oneof _instance.

Type

str

class google.cloud.compute_v1.types.InstanceConsumptionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

guest_cpus

The number of virtual CPUs that are available to the instance.

This field is a member of oneof _guest_cpus.

Type

int

local_ssd_gb

The amount of local SSD storage available to the instance, defined in GiB.

This field is a member of oneof _local_ssd_gb.

Type

int

memory_mb

The amount of physical memory available to the instance, defined in MiB.

This field is a member of oneof _memory_mb.

Type

int

min_node_cpus

The minimal guaranteed number of virtual CPUs that are reserved.

This field is a member of oneof _min_node_cpus.

Type

int

class google.cloud.compute_v1.types.InstanceGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups.

creation_timestamp

[Output Only] The creation timestamp for this instance group in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

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.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] A unique identifier for this instance group, generated by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] The resource type, which is always compute#instanceGroup for instance groups.

This field is a member of oneof _kind.

Type

str

name

The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

This field is a member of oneof _name.

Type

str

named_ports

Assigns a name to a port number. For example: {name: “http”, port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: “app1”, port: 8080}, {name: “app1”, port: 8081}, {name: “app2”, port: 8082}] Named ports apply to all instances in this instance group.

Type

MutableSequence[google.cloud.compute_v1.types.NamedPort]

network

[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

This field is a member of oneof _network.

Type

str

region

[Output Only] The URL of the region where the instance group is located (for regional resources).

This field is a member of oneof _region.

Type

str

self_link

[Output Only] The URL for this instance group. The server generates this URL.

This field is a member of oneof _self_link.

Type

str

size

[Output Only] The total number of instances in the instance group.

This field is a member of oneof _size.

Type

int

subnetwork

[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

This field is a member of oneof _subnetwork.

Type

str

zone

[Output Only] The URL of the zone where the instance group is located (for zonal resources).

This field is a member of oneof _zone.

Type

str

class google.cloud.compute_v1.types.InstanceGroupAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceGroupsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.InstanceGroupsScopedList]

kind

[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstanceGroupList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of InstanceGroup resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceGroup resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroup]

kind

[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceGroupManager(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

all_instances_config

Specifies configuration that overrides the instance template configuration for the group.

This field is a member of oneof _all_instances_config.

Type

google.cloud.compute_v1.types.InstanceGroupManagerAllInstancesConfig

auto_healing_policies

The autohealing policy for this managed instance group. You can specify only one value.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroupManagerAutoHealingPolicy]

base_instance_name

The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of “vm-###” results in “vm-001” as a VM name. @pattern a-z

This field is a member of oneof _base_instance_name.

Type

str

creation_timestamp

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

current_actions

[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

This field is a member of oneof _current_actions.

Type

google.cloud.compute_v1.types.InstanceGroupManagerActionsSummary

description

An optional description of this resource.

This field is a member of oneof _description.

Type

str

distribution_policy

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

This field is a member of oneof _distribution_policy.

Type

google.cloud.compute_v1.types.DistributionPolicy

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. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] A unique identifier for this resource type. The server generates this identifier.

This field is a member of oneof _id.

Type

int

instance_flexibility_policy

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

This field is a member of oneof _instance_flexibility_policy.

Type

google.cloud.compute_v1.types.InstanceGroupManagerInstanceFlexibilityPolicy

instance_group

[Output Only] The URL of the Instance Group resource.

This field is a member of oneof _instance_group.

Type

str

instance_lifecycle_policy

The repair policy for this managed instance group.

This field is a member of oneof _instance_lifecycle_policy.

Type

google.cloud.compute_v1.types.InstanceGroupManagerInstanceLifecyclePolicy

instance_template

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group’s updatePolicy.type to PROACTIVE.

This field is a member of oneof _instance_template.

Type

str

kind

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

This field is a member of oneof _kind.

Type

str

list_managed_instances_results

Pagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values.

This field is a member of oneof _list_managed_instances_results.

Type

str

name

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

This field is a member of oneof _name.

Type

str

named_ports

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

Type

MutableSequence[google.cloud.compute_v1.types.NamedPort]

region

[Output Only] The URL of the region where the managed instance group resides (for regional resources).

This field is a member of oneof _region.

Type

str

satisfies_pzi

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzi.

Type

bool

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

self_link

[Output Only] The URL for this managed instance group. The server defines this URL.

This field is a member of oneof _self_link.

Type

str

stateful_policy

Stateful configuration for this Instanced Group Manager

This field is a member of oneof _stateful_policy.

Type

google.cloud.compute_v1.types.StatefulPolicy

status

[Output Only] The status of this managed instance group.

This field is a member of oneof _status.

Type

google.cloud.compute_v1.types.InstanceGroupManagerStatus

target_pools

The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

Type

MutableSequence[str]

target_size

The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.

This field is a member of oneof _target_size.

Type

int

update_policy

The update policy for this managed instance group.

This field is a member of oneof _update_policy.

Type

google.cloud.compute_v1.types.InstanceGroupManagerUpdatePolicy

versions

Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroupManagerVersion]

zone

[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

This field is a member of oneof _zone.

Type

str

class ListManagedInstancesResults(value)

Bases: proto.enums.Enum

Pagination behavior of the listManagedInstances API method for this managed instance group.

Values:

UNDEFINED_LIST_MANAGED_INSTANCES_RESULTS (0):

A value indicating that the enum field is not set.

PAGELESS (32183464):

(Default) Pagination is disabled for the group’s listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response.

PAGINATED (40190637):

Pagination is enabled for the group’s listManagedInstances API method. maxResults and pageToken query parameters are respected.

class google.cloud.compute_v1.types.InstanceGroupManagerActionsSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This field is a member of oneof _abandoning.

Type

int

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. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

This field is a member of oneof _creating.

Type

int

creating_without_retries

[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.

This field is a member of oneof _creating_without_retries.

Type

int

deleting

[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

This field is a member of oneof _deleting.

Type

int

none

[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

This field is a member of oneof _none.

Type

int

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.

This field is a member of oneof _recreating.

Type

int

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.

This field is a member of oneof _refreshing.

Type

int

restarting

[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

This field is a member of oneof _restarting.

Type

int

resuming

[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.

This field is a member of oneof _resuming.

Type

int

starting

[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.

This field is a member of oneof _starting.

Type

int

stopping

[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.

This field is a member of oneof _stopping.

Type

int

suspending

[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.

This field is a member of oneof _suspending.

Type

int

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.

This field is a member of oneof _verifying.

Type

int

class google.cloud.compute_v1.types.InstanceGroupManagerAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceGroupManagersScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.InstanceGroupManagersScopedList]

kind

[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstanceGroupManagerAllInstancesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

properties

Properties to set on all instances in the group. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting allInstancesConfig on the group, you must update the group’s instances to apply the configuration. To apply the configuration, set the group’s updatePolicy.type field to use proactive updates or use the applyUpdatesToInstances method.

This field is a member of oneof _properties.

Type

google.cloud.compute_v1.types.InstancePropertiesPatch

class google.cloud.compute_v1.types.InstanceGroupManagerAutoHealingPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

health_check

The URL for the health check that signals autohealing.

This field is a member of oneof _health_check.

Type

str

initial_delay_sec

The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM’s initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.

This field is a member of oneof _initial_delay_sec.

Type

int

class google.cloud.compute_v1.types.InstanceGroupManagerInstanceFlexibilityPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_selections

Named instance selections configuring properties that the group will use when creating new VMs.

Type

MutableMapping[str, google.cloud.compute_v1.types.InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection]

class InstanceSelectionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

machine_types

Full machine-type names, e.g. “n1-standard-16”.

Type

MutableSequence[str]

rank

Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference.

This field is a member of oneof _rank.

Type

int

class google.cloud.compute_v1.types.InstanceGroupManagerInstanceLifecyclePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

default_action_on_failure

The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. Check the DefaultActionOnFailure enum for the list of possible values.

This field is a member of oneof _default_action_on_failure.

Type

str

force_update_on_repair

A bit indicating whether to forcefully apply the group’s latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group’s update policy. - YES: If configuration updates are available, they are applied during repair. Check the ForceUpdateOnRepair enum for the list of possible values.

This field is a member of oneof _force_update_on_repair.

Type

str

class DefaultActionOnFailure(value)

Bases: proto.enums.Enum

The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM.

Values:

UNDEFINED_DEFAULT_ACTION_ON_FAILURE (0):

A value indicating that the enum field is not set.

DO_NOTHING (451307513):

MIG does not repair a failed or an unhealthy VM.

REPAIR (266277773):

(Default) MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG.

class ForceUpdateOnRepair(value)

Bases: proto.enums.Enum

A bit indicating whether to forcefully apply the group’s latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group’s update policy. - YES: If configuration updates are available, they are applied during repair.

Values:

UNDEFINED_FORCE_UPDATE_ON_REPAIR (0):

A value indicating that the enum field is not set.

NO (2497):

No description available.

YES (87751):

No description available.

class google.cloud.compute_v1.types.InstanceGroupManagerList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] A list of managed instance groups.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceGroupManager resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroupManager]

kind

[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceGroupManagerResizeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.

creation_timestamp

[Output Only] The creation timestamp for this resize request in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] A unique identifier for this resource type. The server generates this identifier.

This field is a member of oneof _id.

Type

int

kind

[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.

This field is a member of oneof _kind.

Type

str

name

The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.

This field is a member of oneof _name.

Type

str

requested_run_duration

Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.

This field is a member of oneof _requested_run_duration.

Type

google.cloud.compute_v1.types.Duration

resize_by

The number of instances to be created by this resize request. The group’s target size will be increased by this number. This field cannot be used together with ‘instances’.

This field is a member of oneof _resize_by.

Type

int

self_link

[Output Only] The URL for this resize request. The server defines this URL.

This field is a member of oneof _self_link.

Type

str

self_link_with_id

[Output Only] Server-defined URL for this resource with the resource id.

This field is a member of oneof _self_link_with_id.

Type

str

state

[Output only] Current state of the request. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

status

[Output only] Status of the request.

This field is a member of oneof _status.

Type

google.cloud.compute_v1.types.InstanceGroupManagerResizeRequestStatus

zone

[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.

This field is a member of oneof _zone.

Type

str

class State(value)

Bases: proto.enums.Enum

[Output only] Current state of the request.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACCEPTED (246714279):

The request was created successfully and was accepted for provisioning when the capacity becomes available.

CANCELLED (41957681):

The request is cancelled.

CREATING (455564985):

Resize request is being created and may still fail creation.

FAILED (455706685):

The request failed before or during provisioning. If the request fails during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.

STATE_UNSPECIFIED (470755401):

Default value. This value should never be returned.

SUCCEEDED (511103553):

The request succeeded.

class google.cloud.compute_v1.types.InstanceGroupManagerResizeRequestStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

error

[Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.

This field is a member of oneof _error.

Type

google.cloud.compute_v1.types.Error

last_attempt

[Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it’s still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the “error” field only.

This field is a member of oneof _last_attempt.

Type

google.cloud.compute_v1.types.InstanceGroupManagerResizeRequestStatusLastAttempt

class google.cloud.compute_v1.types.InstanceGroupManagerResizeRequestStatusLastAttempt(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

error

Errors that prevented the ResizeRequest to be fulfilled.

This field is a member of oneof _error.

Type

google.cloud.compute_v1.types.Error

class google.cloud.compute_v1.types.InstanceGroupManagerResizeRequestsListResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] A list of resize requests.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of resize request resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroupManagerResizeRequest]

kind

[Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceGroupManagerStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

all_instances_config

[Output only] Status of all-instances configuration on the group.

This field is a member of oneof _all_instances_config.

Type

google.cloud.compute_v1.types.InstanceGroupManagerStatusAllInstancesConfig

autoscaler

[Output Only] The URL of the Autoscaler that targets this instance group manager.

This field is a member of oneof _autoscaler.

Type

str

is_stable

[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.

This field is a member of oneof _is_stable.

Type

bool

stateful

[Output Only] Stateful status of the given Instance Group Manager.

This field is a member of oneof _stateful.

Type

google.cloud.compute_v1.types.InstanceGroupManagerStatusStateful

version_target

[Output Only] A status of consistency of Instances’ versions with their target version specified by version field on Instance Group Manager.

This field is a member of oneof _version_target.

Type

google.cloud.compute_v1.types.InstanceGroupManagerStatusVersionTarget

class google.cloud.compute_v1.types.InstanceGroupManagerStatusAllInstancesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

current_revision

[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.

This field is a member of oneof _current_revision.

Type

str

effective

[Output Only] A bit indicating whether this configuration has been applied to all managed instances in the group.

This field is a member of oneof _effective.

Type

bool

class google.cloud.compute_v1.types.InstanceGroupManagerStatusStateful(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

has_stateful_config

[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.

This field is a member of oneof _has_stateful_config.

Type

bool

per_instance_configs

[Output Only] Status of per-instance configurations on the instances.

This field is a member of oneof _per_instance_configs.

Type

google.cloud.compute_v1.types.InstanceGroupManagerStatusStatefulPerInstanceConfigs

class google.cloud.compute_v1.types.InstanceGroupManagerStatusStatefulPerInstanceConfigs(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

all_effective

A bit indicating if all of the group’s per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.

This field is a member of oneof _all_effective.

Type

bool

class google.cloud.compute_v1.types.InstanceGroupManagerStatusVersionTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

is_reached

[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances’ target version are specified by version field on Instance Group Manager.

This field is a member of oneof _is_reached.

Type

bool

class google.cloud.compute_v1.types.InstanceGroupManagerUpdatePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_redistribution_type

The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. Check the InstanceRedistributionType enum for the list of possible values.

This field is a member of oneof _instance_redistribution_type.

Type

str

max_surge

The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

This field is a member of oneof _max_surge.

Type

google.cloud.compute_v1.types.FixedOrPercent

max_unavailable

The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance’s status is RUNNING. - If there is a health check on the instance group, the instance’s health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

This field is a member of oneof _max_unavailable.

Type

google.cloud.compute_v1.types.FixedOrPercent

minimal_action

Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes. Check the MinimalAction enum for the list of possible values.

This field is a member of oneof _minimal_action.

Type

str

most_disruptive_allowed_action

Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. Check the MostDisruptiveAllowedAction enum for the list of possible values.

This field is a member of oneof _most_disruptive_allowed_action.

Type

str

replacement_method

What action should be used to replace instances. See minimal_action.REPLACE Check the ReplacementMethod enum for the list of possible values.

This field is a member of oneof _replacement_method.

Type

str

type_

The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class InstanceRedistributionType(value)

Bases: proto.enums.Enum

The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. Additional supported values which may be not listed in the enum directly due to technical reasons:

NONE PROACTIVE

Values:

UNDEFINED_INSTANCE_REDISTRIBUTION_TYPE (0):

A value indicating that the enum field is not set.

class MinimalAction(value)

Bases: proto.enums.Enum

Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes. Additional supported values which may be not listed in the enum directly due to technical reasons:

NONE REFRESH REPLACE RESTART

Values:

UNDEFINED_MINIMAL_ACTION (0):

A value indicating that the enum field is not set.

class MostDisruptiveAllowedAction(value)

Bases: proto.enums.Enum

Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. Additional supported values which may be not listed in the enum directly due to technical reasons:

NONE REFRESH REPLACE RESTART

Values:

UNDEFINED_MOST_DISRUPTIVE_ALLOWED_ACTION (0):

A value indicating that the enum field is not set.

class ReplacementMethod(value)

Bases: proto.enums.Enum

What action should be used to replace instances. See minimal_action.REPLACE

Values:

UNDEFINED_REPLACEMENT_METHOD (0):

A value indicating that the enum field is not set.

RECREATE (522644719):

Instances will be recreated (with the same name)

SUBSTITUTE (280924314):

Default option: instances will be deleted and created (with a new name)

class Type(value)

Bases: proto.enums.Enum

The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. Additional supported values which may be not listed in the enum directly due to technical reasons:

PROACTIVE

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

OPPORTUNISTIC (429530089):

MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.

class google.cloud.compute_v1.types.InstanceGroupManagerVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_template

The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the targetSize for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group’s updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the targetSize for this version is reached.

This field is a member of oneof _instance_template.

Type

str

name

Name of the version. Unique among all versions in the scope of this managed instance group.

This field is a member of oneof _name.

Type

str

target_size

Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

This field is a member of oneof _target_size.

Type

google.cloud.compute_v1.types.FixedOrPercent

class google.cloud.compute_v1.types.InstanceGroupManagersAbandonInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Type

MutableSequence[str]

class google.cloud.compute_v1.types.InstanceGroupManagersApplyUpdatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

InstanceGroupManagers.applyUpdatesToInstances

all_instances

Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.

This field is a member of oneof _all_instances.

Type

bool

instances

The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Type

MutableSequence[str]

minimal_action

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. Check the MinimalAction enum for the list of possible values.

This field is a member of oneof _minimal_action.

Type

str

most_disruptive_allowed_action

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. Check the MostDisruptiveAllowedAction enum for the list of possible values.

This field is a member of oneof _most_disruptive_allowed_action.

Type

str

class MinimalAction(value)

Bases: proto.enums.Enum

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. Additional supported values which may be not listed in the enum directly due to technical reasons:

NONE REFRESH REPLACE RESTART

Values:

UNDEFINED_MINIMAL_ACTION (0):

A value indicating that the enum field is not set.

class MostDisruptiveAllowedAction(value)

Bases: proto.enums.Enum

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. Additional supported values which may be not listed in the enum directly due to technical reasons:

NONE REFRESH REPLACE RESTART

Values:

UNDEFINED_MOST_DISRUPTIVE_ALLOWED_ACTION (0):

A value indicating that the enum field is not set.

class google.cloud.compute_v1.types.InstanceGroupManagersCreateInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

InstanceGroupManagers.createInstances

instances

[Required] List of specifications of per-instance configs.

Type

MutableSequence[google.cloud.compute_v1.types.PerInstanceConfig]

class google.cloud.compute_v1.types.InstanceGroupManagersDeleteInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.

Type

MutableSequence[str]

skip_instances_on_validation_error

Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to false and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group’s zone or region.

This field is a member of oneof _skip_instances_on_validation_error.

Type

bool

class google.cloud.compute_v1.types.InstanceGroupManagersDeletePerInstanceConfigsReq(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

InstanceGroupManagers.deletePerInstanceConfigs

names

The list of instance names for which we want to delete per-instance configs on this managed instance group.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.InstanceGroupManagersListErrorsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

items

[Output Only] The list of errors of the managed instance group.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceManagedByIgmError]

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

class google.cloud.compute_v1.types.InstanceGroupManagersListManagedInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

managed_instances

[Output Only] The list of instances in the managed instance group.

Type

MutableSequence[google.cloud.compute_v1.types.ManagedInstance]

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

class google.cloud.compute_v1.types.InstanceGroupManagersListPerInstanceConfigsResp(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

items

[Output Only] The list of PerInstanceConfig.

Type

MutableSequence[google.cloud.compute_v1.types.PerInstanceConfig]

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceGroupManagersPatchPerInstanceConfigsReq(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

InstanceGroupManagers.patchPerInstanceConfigs

per_instance_configs

The list of per-instance configurations to insert or patch on this managed instance group.

Type

MutableSequence[google.cloud.compute_v1.types.PerInstanceConfig]

class google.cloud.compute_v1.types.InstanceGroupManagersRecreateInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Type

MutableSequence[str]

class google.cloud.compute_v1.types.InstanceGroupManagersScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_group_managers

[Output Only] The list of managed instance groups that are contained in the specified project and zone.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroupManager]

warning

[Output Only] The warning that replaces the list of managed instance groups when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceGroupManagersSetInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_template

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group’s updatePolicy.type to PROACTIVE.

This field is a member of oneof _instance_template.

Type

str

class google.cloud.compute_v1.types.InstanceGroupManagersSetTargetPoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This field is a member of oneof _fingerprint.

Type

str

target_pools

The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.InstanceGroupManagersUpdatePerInstanceConfigsReq(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

InstanceGroupManagers.updatePerInstanceConfigs

per_instance_configs

The list of per-instance configurations to insert or patch on this managed instance group.

Type

MutableSequence[google.cloud.compute_v1.types.PerInstanceConfig]

class google.cloud.compute_v1.types.InstanceGroupsAddInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

The list of instances to add to the instance group.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceReference]

class google.cloud.compute_v1.types.InstanceGroupsListInstances(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceWithNamedPorts resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceWithNamedPorts]

kind

[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceGroupsListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_state

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. Check the InstanceState enum for the list of possible values.

This field is a member of oneof _instance_state.

Type

str

class InstanceState(value)

Bases: proto.enums.Enum

A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.

Values:

UNDEFINED_INSTANCE_STATE (0):

A value indicating that the enum field is not set.

ALL (64897):

Includes all instances in the generated list regardless of their state.

RUNNING (121282975):

Includes instances in the generated list only if they have a RUNNING state.

class google.cloud.compute_v1.types.InstanceGroupsRemoveInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

The list of instances to remove from the instance group.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceReference]

class google.cloud.compute_v1.types.InstanceGroupsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_groups

[Output Only] The list of instance groups that are contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroup]

warning

[Output Only] An informational warning that replaces the list of instance groups when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceGroupsSetNamedPortsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This field is a member of oneof _fingerprint.

Type

str

named_ports

The list of named ports to set for this instance group.

Type

MutableSequence[google.cloud.compute_v1.types.NamedPort]

class google.cloud.compute_v1.types.InstanceList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of instances.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Instance resources.

Type

MutableSequence[google.cloud.compute_v1.types.Instance]

kind

[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceListReferrers(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of instance referrers.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Reference resources.

Type

MutableSequence[google.cloud.compute_v1.types.Reference]

kind

[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceManagedByIgmError(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

error

[Output Only] Contents of the error.

This field is a member of oneof _error.

Type

google.cloud.compute_v1.types.InstanceManagedByIgmErrorManagedInstanceError

instance_action_details

[Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional.

This field is a member of oneof _instance_action_details.

Type

google.cloud.compute_v1.types.InstanceManagedByIgmErrorInstanceActionDetails

timestamp

[Output Only] The time that this error occurred. This value is in RFC3339 text format.

This field is a member of oneof _timestamp.

Type

str

class google.cloud.compute_v1.types.InstanceManagedByIgmErrorInstanceActionDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

action

[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values: Check the Action enum for the list of possible values.

This field is a member of oneof _action.

Type

str

instance

[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.

This field is a member of oneof _instance.

Type

str

version

[Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created.

This field is a member of oneof _version.

Type

google.cloud.compute_v1.types.ManagedInstanceVersion

class Action(value)

Bases: proto.enums.Enum

[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:

Values:

UNDEFINED_ACTION (0):

A value indicating that the enum field is not set.

ABANDONING (388244813):

The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.

CREATING (455564985):

The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.

CREATING_WITHOUT_RETRIES (428843785):

The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group’s targetSize value is decreased.

DELETING (528602024):

The managed instance group is permanently deleting this instance.

NONE (2402104):

The managed instance group has not scheduled any actions for this instance.

RECREATING (287278572):

The managed instance group is recreating this instance.

REFRESHING (163266343):

The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.

RESTARTING (320534387):

The managed instance group is restarting this instance.

RESUMING (446856618):

The managed instance group is resuming this instance.

STARTING (488820800):

The managed instance group is starting this instance.

STOPPING (350791796):

The managed instance group is stopping this instance.

SUSPENDING (514206246):

The managed instance group is suspending this instance.

VERIFYING (16982185):

The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group’s autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions).

class google.cloud.compute_v1.types.InstanceManagedByIgmErrorManagedInstanceError(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

code

[Output Only] Error code.

This field is a member of oneof _code.

Type

str

message

[Output Only] Error message.

This field is a member of oneof _message.

Type

str

class google.cloud.compute_v1.types.InstanceMoveRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

destination_zone

The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone

This field is a member of oneof _destination_zone.

Type

str

target_instance

The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance

This field is a member of oneof _target_instance.

Type

str

class google.cloud.compute_v1.types.InstanceParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional instance params.

resource_manager_tags

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

Type

MutableMapping[str, str]

class ResourceManagerTagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstanceProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

advanced_machine_features

Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.

This field is a member of oneof _advanced_machine_features.

Type

google.cloud.compute_v1.types.AdvancedMachineFeatures

can_ip_forward

Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

This field is a member of oneof _can_ip_forward.

Type

bool

confidential_instance_config

Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.

This field is a member of oneof _confidential_instance_config.

Type

google.cloud.compute_v1.types.ConfidentialInstanceConfig

description

An optional text description for the instances that are created from these properties.

This field is a member of oneof _description.

Type

str

disks

An array of disks that are associated with the instances that are created from these properties.

Type

MutableSequence[google.cloud.compute_v1.types.AttachedDisk]

guest_accelerators

A list of guest accelerator cards’ type and count to use for instances created from these properties.

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorConfig]

key_revocation_action_type

KeyRevocationActionType of the instance. Supported options are “STOP” and “NONE”. The default value is “NONE” if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.

This field is a member of oneof _key_revocation_action_type.

Type

str

labels

Labels to apply to instances that are created from these properties.

Type

MutableMapping[str, str]

machine_type

The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example n2-standard-4. If you use the machine type full or partial URL, for example projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4, the request will result in an INTERNAL_ERROR.

This field is a member of oneof _machine_type.

Type

str

metadata

The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

This field is a member of oneof _metadata.

Type

google.cloud.compute_v1.types.Metadata

min_cpu_platform

Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: “Intel Haswell” or minCpuPlatform: “Intel Sandy Bridge”. For more information, read Specifying a Minimum CPU Platform.

This field is a member of oneof _min_cpu_platform.

Type

str

network_interfaces

An array of network access configurations for this interface.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkInterface]

network_performance_config

Note that for MachineImage, this is not supported yet.

This field is a member of oneof _network_performance_config.

Type

google.cloud.compute_v1.types.NetworkPerformanceConfig

private_ipv6_google_access

The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

This field is a member of oneof _private_ipv6_google_access.

Type

str

reservation_affinity

Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.

This field is a member of oneof _reservation_affinity.

Type

google.cloud.compute_v1.types.ReservationAffinity

resource_manager_tags

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

Type

MutableMapping[str, str]

resource_policies

Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.

Type

MutableSequence[str]

scheduling

Specifies the scheduling options for the instances that are created from these properties.

This field is a member of oneof _scheduling.

Type

google.cloud.compute_v1.types.Scheduling

service_accounts

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

Type

MutableSequence[google.cloud.compute_v1.types.ServiceAccount]

shielded_instance_config

Note that for MachineImage, this is not supported yet.

This field is a member of oneof _shielded_instance_config.

Type

google.cloud.compute_v1.types.ShieldedInstanceConfig

tags

A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

This field is a member of oneof _tags.

Type

google.cloud.compute_v1.types.Tags

class KeyRevocationActionType(value)

Bases: proto.enums.Enum

KeyRevocationActionType of the instance. Supported options are “STOP” and “NONE”. The default value is “NONE” if it is not specified.

Values:

UNDEFINED_KEY_REVOCATION_ACTION_TYPE (0):

A value indicating that the enum field is not set.

KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED (467110106):

Default value. This value is unused.

NONE (2402104):

Indicates user chose no operation.

STOP (2555906):

Indicates user chose to opt for VM shutdown on key revocation.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class PrivateIpv6GoogleAccess(value)

Bases: proto.enums.Enum

The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.

Values:

UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS (0):

A value indicating that the enum field is not set.

ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE (427975994):

Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance’s default network interface will be assigned an internal IPv6 prefix if it doesn’t have before.

ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE (288210263):

Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance’s default network interface will be assigned an internal IPv6 prefix if it doesn’t have before.

INHERIT_FROM_SUBNETWORK (530256959):

Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.

class ResourceManagerTagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstancePropertiesPatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the change that you want to make to the instance properties.

labels

The label key-value pairs that you want to patch onto the instance.

Type

MutableMapping[str, str]

metadata

The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.

Type

MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstanceReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance

The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances

This field is a member of oneof _instance.

Type

str

class google.cloud.compute_v1.types.InstanceSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.

fingerprint

Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource’s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.

This field is a member of oneof _fingerprint.

Type

str

kind

[Output Only] Type of the resource. Always compute#instance_settings for instance settings.

This field is a member of oneof _kind.

Type

str

metadata

The metadata key/value pairs assigned to all the instances in the corresponding scope.

This field is a member of oneof _metadata.

Type

google.cloud.compute_v1.types.InstanceSettingsMetadata

zone

[Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _zone.

Type

str

class google.cloud.compute_v1.types.InstanceSettingsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

items

A metadata key/value items map. The total size of all keys and values must be less than 512KB.

Type

MutableMapping[str, str]

kind

[Output Only] Type of the resource. Always compute#metadata for metadata.

This field is a member of oneof _kind.

Type

str

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstanceTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * Global * Regional You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.

creation_timestamp

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] A unique identifier for this instance template. The server defines this identifier.

This field is a member of oneof _id.

Type

int

kind

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

properties

The instance properties for this instance template.

This field is a member of oneof _properties.

Type

google.cloud.compute_v1.types.InstanceProperties

region

[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] The URL for this instance template. The server defines this URL.

This field is a member of oneof _self_link.

Type

str

source_instance

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

This field is a member of oneof _source_instance.

Type

str

source_instance_params

The source instance params to use to create this instance template.

This field is a member of oneof _source_instance_params.

Type

google.cloud.compute_v1.types.SourceInstanceParams

class google.cloud.compute_v1.types.InstanceTemplateAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of InstanceTemplatesScopedList.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceTemplatesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.InstanceTemplatesScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstanceTemplateList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of instance templates.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceTemplate resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceTemplate]

kind

[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceTemplatesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_templates

[Output Only] A list of instance templates that are contained within the specified project and zone.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceTemplate]

warning

[Output Only] An informational warning that replaces the list of instance templates when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstanceWithNamedPorts(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance

[Output Only] The URL of the instance.

This field is a member of oneof _instance.

Type

str

named_ports

[Output Only] The named ports that belong to this instance group.

Type

MutableSequence[google.cloud.compute_v1.types.NamedPort]

status

[Output Only] The status of the instance. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the instance.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

DEPROVISIONING (428935662):

The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.

PROVISIONING (290896621):

Resources are being allocated for the instance.

REPAIRING (413483285):

The instance is in repair.

RUNNING (121282975):

The instance is running.

STAGING (431072283):

All required resources have been allocated and the instance is being started.

STOPPED (444276141):

The instance has stopped successfully.

STOPPING (350791796):

The instance is currently stopping (either being deleted or killed).

SUSPENDED (51223995):

The instance has suspended.

SUSPENDING (514206246):

The instance is suspending.

TERMINATED (250018339):

The instance has stopped (either by explicit action or underlying failure).

class google.cloud.compute_v1.types.InstancesAddResourcePoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource_policies

Resource policies to be added to this instance.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.InstancesBulkInsertOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

per_location_status

Status information per location (location name is key). Example key: zones/us-central1-a

Type

MutableMapping[str, google.cloud.compute_v1.types.BulkInsertOperationStatus]

class PerLocationStatusEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstancesGetEffectiveFirewallsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

firewall_policys

[Output Only] Effective firewalls from firewall policies.

Type

MutableSequence[google.cloud.compute_v1.types.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy]

firewalls

Effective firewalls on the instance.

Type

MutableSequence[google.cloud.compute_v1.types.Firewall]

class google.cloud.compute_v1.types.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

display_name

[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.

This field is a member of oneof _display_name.

Type

str

name

[Output Only] The name of the firewall policy.

This field is a member of oneof _name.

Type

str

priority

[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.

This field is a member of oneof _priority.

Type

int

rules

[Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyRule]

short_name

[Output Only] The short name of the firewall policy.

This field is a member of oneof _short_name.

Type

str

type_

[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

HIERARCHY (69902869):

No description available.

NETWORK (413984270):

No description available.

NETWORK_REGIONAL (190804272):

No description available.

SYSTEM_GLOBAL (60099507):

No description available.

SYSTEM_REGIONAL (161777199):

No description available.

UNSPECIFIED (526786327):

No description available.

class google.cloud.compute_v1.types.InstancesRemoveResourcePoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource_policies

Resource policies to be removed from this instance.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.InstancesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

[Output Only] A list of instances contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.Instance]

warning

[Output Only] Informational warning which replaces the list of instances when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstancesSetLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

label_fingerprint

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.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Type

MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstancesSetMachineResourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

guest_accelerators

A list of the type and count of accelerator cards attached to the instance.

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorConfig]

class google.cloud.compute_v1.types.InstancesSetMachineTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

machine_type

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

This field is a member of oneof _machine_type.

Type

str

class google.cloud.compute_v1.types.InstancesSetMinCpuPlatformRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

min_cpu_platform

Minimum cpu/platform this instance should be started at.

This field is a member of oneof _min_cpu_platform.

Type

str

class google.cloud.compute_v1.types.InstancesSetNameRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

current_name

The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

This field is a member of oneof _current_name.

Type

str

name

The name to be applied to the instance. Needs to be RFC 1035 compliant.

This field is a member of oneof _name.

Type

str

class google.cloud.compute_v1.types.InstancesSetSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_interfaces

The network interfaces that the security policy will be applied to. Network interfaces use the nicN naming format. You can only set a security policy for network interfaces with an access config.

Type

MutableSequence[str]

security_policy

A full or partial URL to a security policy to add to this instance. If this field is set to an empty string it will remove the associated security policy.

This field is a member of oneof _security_policy.

Type

str

class google.cloud.compute_v1.types.InstancesSetServiceAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

email

Email address of the service account.

This field is a member of oneof _email.

Type

str

scopes

The list of scopes to be made available for this service account.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.InstancesStartWithEncryptionKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

disks

Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.

Type

MutableSequence[google.cloud.compute_v1.types.CustomerEncryptionKeyProtectedDisk]

class google.cloud.compute_v1.types.InstantSnapshot(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback points quickly..

architecture

[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

This field is a member of oneof _architecture.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

disk_size_gb

[Output Only] Size of the source disk, specified in GB.

This field is a member of oneof _disk_size_gb.

Type

int

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.

Type

MutableMapping[str, str]

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.

This field is a member of oneof _name.

Type

str

region

[Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _region.

Type

str

resource_status

[Output Only] Status information for the instant snapshot resource.

This field is a member of oneof _resource_status.

Type

google.cloud.compute_v1.types.InstantSnapshotResourceStatus

satisfies_pzi

Output only. Reserved for future use.

This field is a member of oneof _satisfies_pzi.

Type

bool

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

self_link_with_id

[Output Only] Server-defined URL for this resource’s resource id.

This field is a member of oneof _self_link_with_id.

Type

str

source_disk

URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

This field is a member of oneof _source_disk.

Type

str

source_disk_id

[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.

This field is a member of oneof _source_disk_id.

Type

str

status

[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

zone

[Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _zone.

Type

str

class Architecture(value)

Bases: proto.enums.Enum

[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.

Values:

UNDEFINED_ARCHITECTURE (0):

A value indicating that the enum field is not set.

ARCHITECTURE_UNSPECIFIED (394750507):

Default value indicating Architecture is not set.

ARM64 (62547450):

Machines with architecture ARM64

X86_64 (425300551):

Machines with architecture X86_64

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

InstantSnapshot creation is in progress.

DELETING (528602024):

InstantSnapshot is currently being deleted.

FAILED (455706685):

InstantSnapshot creation failed.

READY (77848963):

InstantSnapshot has been created successfully.

UNAVAILABLE (413756464):

InstantSnapshot is currently unavailable and cannot be used for Disk restoration

class google.cloud.compute_v1.types.InstantSnapshotAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstantSnapshotsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.InstantSnapshotsScopedList]

kind

[Output Only] Type of resource. Always compute#instantSnapshotAggregatedList for aggregated lists of instantSnapshots.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InstantSnapshotList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of InstantSnapshot resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstantSnapshot resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstantSnapshot]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InstantSnapshotResourceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

storage_size_bytes

[Output Only] The storage size of this instant snapshot.

This field is a member of oneof _storage_size_bytes.

Type

int

class google.cloud.compute_v1.types.InstantSnapshotsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instant_snapshots

[Output Only] A list of instantSnapshots contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.InstantSnapshot]

warning

[Output Only] Informational warning which replaces the list of instantSnapshots when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.Int64RangeMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.

range_end

The end of the range (exclusive) in signed long integer format.

This field is a member of oneof _range_end.

Type

int

range_start

The start of the range (inclusive) in signed long integer format.

This field is a member of oneof _range_start.

Type

int

class google.cloud.compute_v1.types.Interconnect(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.

admin_enabled

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.

This field is a member of oneof _admin_enabled.

Type

bool

available_features

[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn’t supported and enabling MACsec fails. Check the AvailableFeatures enum for the list of possible values.

Type

MutableSequence[str]

circuit_infos

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectCircuitInfo]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

customer_name

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

This field is a member of oneof _customer_name.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

expected_outages

[Output Only] A list of outages expected for this Interconnect.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectOutageNotification]

google_ip_address

[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

This field is a member of oneof _google_ip_address.

Type

str

google_reference_id

[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

This field is a member of oneof _google_reference_id.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

interconnect_attachments

[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

Type

MutableSequence[str]

interconnect_type

Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Check the InterconnectType enum for the list of possible values.

This field is a member of oneof _interconnect_type.

Type

str

kind

[Output Only] Type of the resource. Always compute#interconnect for interconnects.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Type

MutableMapping[str, str]

link_type

Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. Check the LinkType enum for the list of possible values.

This field is a member of oneof _link_type.

Type

str

location

URL of the InterconnectLocation object that represents where this connection is to be provisioned.

This field is a member of oneof _location.

Type

str

macsec

Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.

This field is a member of oneof _macsec.

Type

google.cloud.compute_v1.types.InterconnectMacsec

macsec_enabled

Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.

This field is a member of oneof _macsec_enabled.

Type

bool

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.

This field is a member of oneof _name.

Type

str

noc_contact_email

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

This field is a member of oneof _noc_contact_email.

Type

str

operational_status

[Output Only] The current status of this Interconnect’s functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. Check the OperationalStatus enum for the list of possible values.

This field is a member of oneof _operational_status.

Type

str

peer_ip_address

[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.

This field is a member of oneof _peer_ip_address.

Type

str

provisioned_link_count

[Output Only] Number of links actually provisioned in this interconnect.

This field is a member of oneof _provisioned_link_count.

Type

int

remote_location

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google’s network that the interconnect is connected to.

This field is a member of oneof _remote_location.

Type

str

requested_features

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn’t valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.

Type

MutableSequence[str]

requested_link_count

Target number of physical links in the link bundle, as requested by the customer.

This field is a member of oneof _requested_link_count.

Type

int

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

state

[Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class AvailableFeatures(value)

Bases: proto.enums.Enum

Additional supported values which may be not listed in the enum directly due to technical reasons: IF_MACSEC

Values:

UNDEFINED_AVAILABLE_FEATURES (0):

A value indicating that the enum field is not set.

class InterconnectType(value)

Bases: proto.enums.Enum

Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

Values:

UNDEFINED_INTERCONNECT_TYPE (0):

A value indicating that the enum field is not set.

DEDICATED (258411983):

A dedicated physical interconnection with the customer.

IT_PRIVATE (335677007):

[Deprecated] A private, physical interconnection with the customer.

PARTNER (461924520):

A partner-managed interconnection shared between customers via partner.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class LinkType(value)

Bases: proto.enums.Enum

Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

Values:

UNDEFINED_LINK_TYPE (0):

A value indicating that the enum field is not set.

LINK_TYPE_ETHERNET_100G_LR (337672551):

100G Ethernet, LR Optics.

LINK_TYPE_ETHERNET_10G_LR (236739749):

10G Ethernet, LR Optics. [(rate_bps) = 10000000000];

class OperationalStatus(value)

Bases: proto.enums.Enum

[Output Only] The current status of this Interconnect’s functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

Values:

UNDEFINED_OPERATIONAL_STATUS (0):

A value indicating that the enum field is not set.

OS_ACTIVE (55721409):

The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.

OS_UNPROVISIONED (239771840):

The interconnect has not completed turnup. No attachments may be provisioned on this interconnect.

class RequestedFeatures(value)

Bases: proto.enums.Enum

Additional supported values which may be not listed in the enum directly due to technical reasons: IF_MACSEC

Values:

UNDEFINED_REQUESTED_FEATURES (0):

A value indicating that the enum field is not set.

class State(value)

Bases: proto.enums.Enum

[Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.

UNPROVISIONED (517333979):

The interconnect has not completed turnup. No attachments may be provisioned on this interconnect.

class google.cloud.compute_v1.types.InterconnectAttachment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

admin_enabled

Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

This field is a member of oneof _admin_enabled.

Type

bool

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: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s Check the Bandwidth enum for the list of possible values.

This field is a member of oneof _bandwidth.

Type

str

candidate_ipv6_subnets

This field is not available.

Type

MutableSequence[str]

candidate_subnets

Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google’s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

Type

MutableSequence[str]

cloud_router_ip_address

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

This field is a member of oneof _cloud_router_ip_address.

Type

str

cloud_router_ipv6_address

[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

This field is a member of oneof _cloud_router_ipv6_address.

Type

str

cloud_router_ipv6_interface_id

This field is not available.

This field is a member of oneof _cloud_router_ipv6_interface_id.

Type

str

configuration_constraints

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

This field is a member of oneof _configuration_constraints.

Type

google.cloud.compute_v1.types.InterconnectAttachmentConfigurationConstraints

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

customer_router_ip_address

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

This field is a member of oneof _customer_router_ip_address.

Type

str

customer_router_ipv6_address

[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

This field is a member of oneof _customer_router_ipv6_address.

Type

str

customer_router_ipv6_interface_id

This field is not available.

This field is a member of oneof _customer_router_ipv6_interface_id.

Type

str

dataplane_version

[Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.

This field is a member of oneof _dataplane_version.

Type

int

description

An optional description of this resource.

This field is a member of oneof _description.

Type

str

edge_availability_domain

Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. Check the EdgeAvailabilityDomain enum for the list of possible values.

This field is a member of oneof _edge_availability_domain.

Type

str

encryption

Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use HA VPN over Cloud Interconnect, the VLAN attachment must be created with this option. Check the Encryption enum for the list of possible values.

This field is a member of oneof _encryption.

Type

str

google_reference_id

[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.

This field is a member of oneof _google_reference_id.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

interconnect

URL of the underlying Interconnect object that this attachment’s traffic will traverse through.

This field is a member of oneof _interconnect.

Type

str

ipsec_internal_addresses

A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway’s IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway’s interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway’s IP address is allocated from the regional external IP address pool.

Type

MutableSequence[str]

kind

[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Type

MutableMapping[str, str]

mtu

Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

This field is a member of oneof _mtu.

Type

int

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.

This field is a member of oneof _name.

Type

str

operational_status

[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. Check the OperationalStatus enum for the list of possible values.

This field is a member of oneof _operational_status.

Type

str

pairing_key

[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form “XXXXX/region/domain”.

This field is a member of oneof _pairing_key.

Type

str

partner_asn

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.

This field is a member of oneof _partner_asn.

Type

int

partner_metadata

Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

This field is a member of oneof _partner_metadata.

Type

google.cloud.compute_v1.types.InterconnectAttachmentPartnerMetadata

private_interconnect_info

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

This field is a member of oneof _private_interconnect_info.

Type

google.cloud.compute_v1.types.InterconnectAttachmentPrivateInfo

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.

This field is a member of oneof _region.

Type

str

remote_service

[Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect’s remote location service provider. Example values: “Amazon Web Services” “Microsoft Azure”. The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.

This field is a member of oneof _remote_service.

Type

str

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 & region within which the Cloud Router is configured.

This field is a member of oneof _router.

Type

str

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

stack_type

The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. Check the StackType enum for the list of possible values.

This field is a member of oneof _stack_type.

Type

str

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: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

subnet_length

Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.

This field is a member of oneof _subnet_length.

Type

int

type_

The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

vlan_tag8021q

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

This field is a member of oneof _vlan_tag8021q.

Type

int

class Bandwidth(value)

Bases: proto.enums.Enum

Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s

Values:

UNDEFINED_BANDWIDTH (0):

A value indicating that the enum field is not set.

BPS_100M (49547958):

100 Mbit/s

BPS_10G (278693006):

10 Gbit/s

BPS_1G (355358448):

1 Gbit/s

BPS_200M (49577749):

200 Mbit/s

BPS_20G (278693967):

20 Gbit/s

BPS_2G (355358479):

2 Gbit/s

BPS_300M (49607540):

300 Mbit/s

BPS_400M (49637331):

400 Mbit/s

BPS_500M (49667122):

500 Mbit/s

BPS_50G (278696850):

50 Gbit/s

BPS_50M (278696856):

50 Mbit/s

BPS_5G (355358572):

5 Gbit/s

class EdgeAvailabilityDomain(value)

Bases: proto.enums.Enum

Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.

Values:

UNDEFINED_EDGE_AVAILABILITY_DOMAIN (0):

A value indicating that the enum field is not set.

AVAILABILITY_DOMAIN_1 (349552090):

No description available.

AVAILABILITY_DOMAIN_2 (349552091):

No description available.

AVAILABILITY_DOMAIN_ANY (375256373):

No description available.

class Encryption(value)

Bases: proto.enums.Enum

Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use HA VPN over Cloud Interconnect, the VLAN attachment must be created with this option.

Values:

UNDEFINED_ENCRYPTION (0):

A value indicating that the enum field is not set.

IPSEC (69882282):

The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.

NONE (2402104):

This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class OperationalStatus(value)

Bases: proto.enums.Enum

[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

Values:

UNDEFINED_OPERATIONAL_STATUS (0):

A value indicating that the enum field is not set.

OS_ACTIVE (55721409):

Indicates that attachment has been turned up and is ready to use.

OS_UNPROVISIONED (239771840):

Indicates that attachment is not ready to use yet, because turnup is not complete.

class StackType(value)

Bases: proto.enums.Enum

The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.

Values:

UNDEFINED_STACK_TYPE (0):

A value indicating that the enum field is not set.

IPV4_IPV6 (22197249):

The interconnect attachment can have both IPv4 and IPv6 addresses.

IPV4_ONLY (22373798):

The interconnect attachment will only be assigned IPv4 addresses.

class State(value)

Bases: proto.enums.Enum

[Output Only] The current state of this attachment’s functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

Indicates that attachment has been turned up and is ready to use.

DEFUNCT (115891759):

The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was wiped out, or because the other side of a Partner attachment was deleted.

PARTNER_REQUEST_RECEIVED (513587304):

A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.

PENDING_CUSTOMER (167494054):

PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer to activate.

PENDING_PARTNER (387890656):

A newly created PARTNER attachment that has not yet been configured on the Partner side.

STATE_UNSPECIFIED (470755401):

No description available.

UNPROVISIONED (517333979):

Indicates that attachment is not ready to use yet, because turnup is not complete.

class Type(value)

Bases: proto.enums.Enum

The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

DEDICATED (258411983):

Attachment to a dedicated interconnect.

PARTNER (461924520):

Attachment to a partner interconnect, created by the customer.

PARTNER_PROVIDER (483261352):

Attachment to a partner interconnect, created by the partner.

class google.cloud.compute_v1.types.InterconnectAttachmentAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InterconnectAttachmentsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.InterconnectAttachmentsScopedList]

kind

[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.InterconnectAttachmentConfigurationConstraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

bgp_md5

[Output Only] Whether the attachment’s BGP session requires/allows/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachment_configuration_constraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested. Check the BgpMd5 enum for the list of possible values.

This field is a member of oneof _bgp_md5.

Type

str

bgp_peer_asn_ranges

[Output Only] List of ASN ranges that the remote location is known to support. Formatted as an array of inclusive ranges {min: min-value, max: max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything in the range 64512-65534. This field is only advisory. Although the API accepts other ranges, these are the ranges that we recommend.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange]

class BgpMd5(value)

Bases: proto.enums.Enum

[Output Only] Whether the attachment’s BGP session requires/allows/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachment_configuration_constraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested.

Values:

UNDEFINED_BGP_MD5 (0):

A value indicating that the enum field is not set.

MD5_OPTIONAL (532156673):

MD5_OPTIONAL: BGP MD5 authentication is supported and can optionally be configured.

MD5_REQUIRED (218034496):

MD5_REQUIRED: BGP MD5 authentication must be configured.

MD5_UNSUPPORTED (86962388):

MD5_UNSUPPORTED: BGP MD5 authentication must not be configured

class google.cloud.compute_v1.types.InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

max_

This field is a member of oneof _max.

Type

int

min_

This field is a member of oneof _min.

Type

int

class google.cloud.compute_v1.types.InterconnectAttachmentList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to the list request, and contains a list of interconnect attachments.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InterconnectAttachment resources.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectAttachment]

kind

[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InterconnectAttachmentPartnerMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.

interconnect_name

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.

This field is a member of oneof _interconnect_name.

Type

str

partner_name

Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.

This field is a member of oneof _partner_name.

Type

str

portal_url

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.

This field is a member of oneof _portal_url.

Type

str

class google.cloud.compute_v1.types.InterconnectAttachmentPrivateInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.

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.

This field is a member of oneof _tag8021q.

Type

int

class google.cloud.compute_v1.types.InterconnectAttachmentsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

interconnect_attachments

A list of interconnect attachments contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectAttachment]

warning

Informational warning which replaces the list of addresses when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InterconnectCircuitInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.

customer_demarc_id

Customer-side demarc ID for this circuit.

This field is a member of oneof _customer_demarc_id.

Type

str

google_circuit_id

Google-assigned unique ID for this circuit. Assigned at circuit turn-up.

This field is a member of oneof _google_circuit_id.

Type

str

google_demarc_id

Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.

This field is a member of oneof _google_demarc_id.

Type

str

class google.cloud.compute_v1.types.InterconnectDiagnostics(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google’s side of the connection.

arp_caches

A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectDiagnosticsARPEntry]

bundle_aggregation_type

The aggregation type of the bundle interface. Check the BundleAggregationType enum for the list of possible values.

This field is a member of oneof _bundle_aggregation_type.

Type

str

bundle_operational_status

The operational status of the bundle interface. Check the BundleOperationalStatus enum for the list of possible values.

This field is a member of oneof _bundle_operational_status.

Type

str

links

A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectDiagnosticsLinkStatus]

mac_address

The MAC address of the Interconnect’s bundle interface.

This field is a member of oneof _mac_address.

Type

str

class BundleAggregationType(value)

Bases: proto.enums.Enum

The aggregation type of the bundle interface.

Values:

UNDEFINED_BUNDLE_AGGREGATION_TYPE (0):

A value indicating that the enum field is not set.

BUNDLE_AGGREGATION_TYPE_LACP (27758925):

LACP is enabled.

BUNDLE_AGGREGATION_TYPE_STATIC (50678873):

LACP is disabled.

class BundleOperationalStatus(value)

Bases: proto.enums.Enum

The operational status of the bundle interface.

Values:

UNDEFINED_BUNDLE_OPERATIONAL_STATUS (0):

A value indicating that the enum field is not set.

BUNDLE_OPERATIONAL_STATUS_DOWN (453842693):

If bundleAggregationType is LACP: LACP is not established and/or all links in the bundle have DOWN operational status. If bundleAggregationType is STATIC: one or more links in the bundle has DOWN operational status.

BUNDLE_OPERATIONAL_STATUS_UP (161366462):

If bundleAggregationType is LACP: LACP is established and at least one link in the bundle has UP operational status. If bundleAggregationType is STATIC: all links in the bundle (typically just one) have UP operational status.

class google.cloud.compute_v1.types.InterconnectDiagnosticsARPEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describing the ARP neighbor entries seen on this link

ip_address

The IP address of this ARP neighbor.

This field is a member of oneof _ip_address.

Type

str

mac_address

The MAC address of this ARP neighbor.

This field is a member of oneof _mac_address.

Type

str

class google.cloud.compute_v1.types.InterconnectDiagnosticsLinkLACPStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

google_system_id

System ID of the port on Google’s side of the LACP exchange.

This field is a member of oneof _google_system_id.

Type

str

neighbor_system_id

System ID of the port on the neighbor’s side of the LACP exchange.

This field is a member of oneof _neighbor_system_id.

Type

str

state

The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class State(value)

Bases: proto.enums.Enum

The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

The link is configured and active within the bundle.

DETACHED (216562546):

The link is not configured within the bundle, this means the rest of the object should be empty.

class google.cloud.compute_v1.types.InterconnectDiagnosticsLinkOpticalPower(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

state

The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

value

Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.

This field is a member of oneof _value.

Type

float

class State(value)

Bases: proto.enums.Enum

The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

HIGH_ALARM (305363284):

The value has crossed above the high alarm threshold.

HIGH_WARNING (220984799):

The value of the current optical power has crossed above the high warning threshold.

LOW_ALARM (316659046):

The value of the current optical power has crossed below the low alarm threshold.

LOW_WARNING (338793841):

The value of the current optical power has crossed below the low warning threshold.

OK (2524):

The value of the current optical power has not crossed a warning threshold.

class google.cloud.compute_v1.types.InterconnectDiagnosticsLinkStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

arp_caches

A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectDiagnosticsARPEntry]

circuit_id

The unique ID for this link assigned during turn up by Google.

This field is a member of oneof _circuit_id.

Type

str

google_demarc

The Demarc address assigned by Google and provided in the LoA.

This field is a member of oneof _google_demarc.

Type

str

lacp_status

This field is a member of oneof _lacp_status.

Type

google.cloud.compute_v1.types.InterconnectDiagnosticsLinkLACPStatus

macsec

Describes the status of MACsec encryption on this link.

This field is a member of oneof _macsec.

Type

google.cloud.compute_v1.types.InterconnectDiagnosticsMacsecStatus

operational_status

The operational status of the link. Check the OperationalStatus enum for the list of possible values.

This field is a member of oneof _operational_status.

Type

str

receiving_optical_power

An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.

This field is a member of oneof _receiving_optical_power.

Type

google.cloud.compute_v1.types.InterconnectDiagnosticsLinkOpticalPower

transmitting_optical_power

An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level.

This field is a member of oneof _transmitting_optical_power.

Type

google.cloud.compute_v1.types.InterconnectDiagnosticsLinkOpticalPower

class OperationalStatus(value)

Bases: proto.enums.Enum

The operational status of the link.

Values:

UNDEFINED_OPERATIONAL_STATUS (0):

A value indicating that the enum field is not set.

LINK_OPERATIONAL_STATUS_DOWN (281653885):

The interface is unable to communicate with the remote end.

LINK_OPERATIONAL_STATUS_UP (305879862):

The interface has low level communication with the remote end.

class google.cloud.compute_v1.types.InterconnectDiagnosticsMacsecStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes the status of MACsec encryption on the link.

ckn

Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational.

This field is a member of oneof _ckn.

Type

str

operational

Indicates whether or not MACsec is operational on this link.

This field is a member of oneof _operational.

Type

bool

class google.cloud.compute_v1.types.InterconnectList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to the list request, and contains a list of interconnects.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Interconnect resources.

Type

MutableSequence[google.cloud.compute_v1.types.Interconnect]

kind

[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InterconnectLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.

address

[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.

This field is a member of oneof _address.

Type

str

availability_zone

[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: “zone1” or “zone2”.

This field is a member of oneof _availability_zone.

Type

str

available_features

[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - MACSEC Check the AvailableFeatures enum for the list of possible values.

Type

MutableSequence[str]

available_link_types

[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR Check the AvailableLinkTypes enum for the list of possible values.

Type

MutableSequence[str]

city

[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: “Chicago, IL”, “Amsterdam, Netherlands”.

This field is a member of oneof _city.

Type

str

continent

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA Check the Continent enum for the list of possible values.

This field is a member of oneof _continent.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

[Output Only] An optional description of the resource.

This field is a member of oneof _description.

Type

str

facility_provider

[Output Only] The name of the provider for this facility (e.g., EQUINIX).

This field is a member of oneof _facility_provider.

Type

str

facility_provider_facility_id

[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

This field is a member of oneof _facility_provider_facility_id.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.

This field is a member of oneof _kind.

Type

str

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

peeringdb_facility_id

[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).

This field is a member of oneof _peeringdb_facility_id.

Type

str

region_infos

[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectLocationRegionInfo]

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

status

[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

supports_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _supports_pzs.

Type

bool

class AvailableFeatures(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_AVAILABLE_FEATURES (0):

A value indicating that the enum field is not set.

IF_MACSEC (396279300):

Media Access Control security (MACsec)

class AvailableLinkTypes(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_AVAILABLE_LINK_TYPES (0):

A value indicating that the enum field is not set.

LINK_TYPE_ETHERNET_100G_LR (337672551):

100G Ethernet, LR Optics.

LINK_TYPE_ETHERNET_10G_LR (236739749):

10G Ethernet, LR Optics. [(rate_bps) = 10000000000];

class Continent(value)

Bases: proto.enums.Enum

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA

Values:

UNDEFINED_CONTINENT (0):

A value indicating that the enum field is not set.

AFRICA (317443706):

No description available.

ASIA_PAC (119782269):

No description available.

C_AFRICA (71993846):

No description available.

C_ASIA_PAC (465668089):

No description available.

C_EUROPE (200369438):

No description available.

C_NORTH_AMERICA (275697048):

No description available.

C_SOUTH_AMERICA (397149792):

No description available.

EUROPE (445819298):

No description available.

NORTH_AMERICA (448015508):

No description available.

SOUTH_AMERICA (32597340):

No description available.

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

AVAILABLE (442079913):

The InterconnectLocation is available for provisioning new Interconnects.

CLOSED (380163436):

The InterconnectLocation is closed for provisioning new Interconnects.

class google.cloud.compute_v1.types.InterconnectLocationList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to the list request, and contains a list of interconnect locations.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InterconnectLocation resources.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectLocation]

kind

[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InterconnectLocationRegionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.

expected_rtt_ms

Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.

This field is a member of oneof _expected_rtt_ms.

Type

int

location_presence

Identifies the network presence of this location. Check the LocationPresence enum for the list of possible values.

This field is a member of oneof _location_presence.

Type

str

region

URL for the region of this location.

This field is a member of oneof _region.

Type

str

class LocationPresence(value)

Bases: proto.enums.Enum

Identifies the network presence of this location.

Values:

UNDEFINED_LOCATION_PRESENCE (0):

A value indicating that the enum field is not set.

GLOBAL (494663587):

This region is not in any common network presence with this InterconnectLocation.

LOCAL_REGION (403535464):

This region shares the same regional network presence as this InterconnectLocation.

LP_GLOBAL (429584062):

[Deprecated] This region is not in any common network presence with this InterconnectLocation.

LP_LOCAL_REGION (488598851):

[Deprecated] This region shares the same regional network presence as this InterconnectLocation.

class google.cloud.compute_v1.types.InterconnectMacsec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router.

fail_open

If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

This field is a member of oneof _fail_open.

Type

bool

pre_shared_keys

Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectMacsecPreSharedKey]

class google.cloud.compute_v1.types.InterconnectMacsecConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

MACsec configuration information for the Interconnect connection. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect connection.

pre_shared_keys

A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectMacsecConfigPreSharedKey]

class google.cloud.compute_v1.types.InterconnectMacsecConfigPreSharedKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.

cak

An auto-generated Connectivity Association Key (CAK) for this key.

This field is a member of oneof _cak.

Type

str

ckn

An auto-generated Connectivity Association Key Name (CKN) for this key.

This field is a member of oneof _ckn.

Type

str

name

User provided name for this pre-shared key.

This field is a member of oneof _name.

Type

str

start_time

User provided timestamp on or after which this key is valid.

This field is a member of oneof _start_time.

Type

str

class google.cloud.compute_v1.types.InterconnectMacsecPreSharedKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.

name

Required. A name for this pre-shared 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.

This field is a member of oneof _name.

Type

str

start_time

A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.

This field is a member of oneof _start_time.

Type

str

class google.cloud.compute_v1.types.InterconnectOutageNotification(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Description of a planned outage on this Interconnect.

affected_circuits

If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.

Type

MutableSequence[str]

description

A description about the purpose of the outage.

This field is a member of oneof _description.

Type

str

end_time

Scheduled end time for the outage (milliseconds since Unix epoch).

This field is a member of oneof _end_time.

Type

int

issue_type

Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with IT_ have been deprecated in favor of the unprefixed values. Check the IssueType enum for the list of possible values.

This field is a member of oneof _issue_type.

Type

str

name

Unique identifier for this outage notification.

This field is a member of oneof _name.

Type

str

source

The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. Check the Source enum for the list of possible values.

This field is a member of oneof _source.

Type

str

start_time

Scheduled start time for the outage (milliseconds since Unix epoch).

This field is a member of oneof _start_time.

Type

int

state

State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with NS_ have been deprecated in favor of the unprefixed values. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class IssueType(value)

Bases: proto.enums.Enum

Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with IT_ have been deprecated in favor of the unprefixed values.

Values:

UNDEFINED_ISSUE_TYPE (0):

A value indicating that the enum field is not set.

IT_OUTAGE (175779973):

[Deprecated] The Interconnect may be completely out of service for some or all of the specified window.

IT_PARTIAL_OUTAGE (92103971):

[Deprecated] Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.

OUTAGE (195285745):

The Interconnect may be completely out of service for some or all of the specified window.

PARTIAL_OUTAGE (147053455):

Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.

class Source(value)

Bases: proto.enums.Enum

The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.

Values:

UNDEFINED_SOURCE (0):

A value indicating that the enum field is not set.

GOOGLE (497439289):

This notification was generated by Google.

NSRC_GOOGLE (510574562):

[Deprecated] This notification was generated by Google.

class State(value)

Bases: proto.enums.Enum

State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with NS_ have been deprecated in favor of the unprefixed values.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.

CANCELLED (41957681):

The outage associated with this notification was cancelled before the outage was due to start.

COMPLETED (309921323):

The outage associated with this notification is complete.

NS_ACTIVE (252563136):

[Deprecated] This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.

NS_CANCELED (506579411):

[Deprecated] The outage associated with this notification was canceled before the outage was due to start.

class google.cloud.compute_v1.types.InterconnectRemoteLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Cross-Cloud Interconnect Remote Location resource. You can use this resource to find remote location details about an Interconnect attachment (VLAN).

address

[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.

This field is a member of oneof _address.

Type

str

attachment_configuration_constraints

[Output Only] Subset of fields from InterconnectAttachment’s |configurationConstraints| field that apply to all attachments for this remote location.

This field is a member of oneof _attachment_configuration_constraints.

Type

google.cloud.compute_v1.types.InterconnectAttachmentConfigurationConstraints

city

[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: “Chicago, IL”, “Amsterdam, Netherlands”.

This field is a member of oneof _city.

Type

str

constraints

[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments.

This field is a member of oneof _constraints.

Type

google.cloud.compute_v1.types.InterconnectRemoteLocationConstraints

continent

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA Check the Continent enum for the list of possible values.

This field is a member of oneof _continent.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

[Output Only] An optional description of the resource.

This field is a member of oneof _description.

Type

str

facility_provider

[Output Only] The name of the provider for this facility (e.g., EQUINIX).

This field is a member of oneof _facility_provider.

Type

str

facility_provider_facility_id

[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

This field is a member of oneof _facility_provider_facility_id.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations.

This field is a member of oneof _kind.

Type

str

lacp

[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED Check the Lacp enum for the list of possible values.

This field is a member of oneof _lacp.

Type

str

max_lag_size100_gbps

[Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.

This field is a member of oneof _max_lag_size100_gbps.

Type

int

max_lag_size10_gbps

[Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.

This field is a member of oneof _max_lag_size10_gbps.

Type

int

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

peeringdb_facility_id

[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).

This field is a member of oneof _peeringdb_facility_id.

Type

str

permitted_connections

[Output Only] Permitted connections.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectRemoteLocationPermittedConnections]

remote_service

[Output Only] Indicates the service provider present at the remote location. Example values: “Amazon Web Services”, “Microsoft Azure”.

This field is a member of oneof _remote_service.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

status

[Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class Continent(value)

Bases: proto.enums.Enum

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA

Values:

UNDEFINED_CONTINENT (0):

A value indicating that the enum field is not set.

AFRICA (317443706):

No description available.

ASIA_PAC (119782269):

No description available.

EUROPE (445819298):

No description available.

NORTH_AMERICA (448015508):

No description available.

SOUTH_AMERICA (32597340):

No description available.

class Lacp(value)

Bases: proto.enums.Enum

[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED

Values:

UNDEFINED_LACP (0):

A value indicating that the enum field is not set.

LACP_SUPPORTED (339576113):

LACP_SUPPORTED: LACP is supported, and enabled by default on the Cross-Cloud Interconnect.

LACP_UNSUPPORTED (203930104):

LACP_UNSUPPORTED: LACP is not supported and is not be enabled on this port. GetDiagnostics shows bundleAggregationType as “static”. GCP does not support LAGs without LACP, so requestedLinkCount must be 1.

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

AVAILABLE (442079913):

The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects.

CLOSED (380163436):

The InterconnectRemoteLocation is closed for provisioning new Cross-Cloud Interconnects.

class google.cloud.compute_v1.types.InterconnectRemoteLocationConstraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

port_pair_remote_location

[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location. Check the PortPairRemoteLocation enum for the list of possible values.

This field is a member of oneof _port_pair_remote_location.

Type

str

port_pair_vlan

[Output Only] Port pair VLAN constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN Check the PortPairVlan enum for the list of possible values.

This field is a member of oneof _port_pair_vlan.

Type

str

subnet_length_range

[Output Only] [min-length, max-length] The minimum and maximum value (inclusive) for the IPv4 subnet length. For example, an interconnectRemoteLocation for Azure has {min: 30, max: 30} because Azure requires /30 subnets. This range specifies the values supported by both cloud providers. Interconnect currently supports /29 and /30 IPv4 subnet lengths. If a remote cloud has no constraint on IPv4 subnet length, the range would thus be {min: 29, max: 30}.

This field is a member of oneof _subnet_length_range.

Type

google.cloud.compute_v1.types.InterconnectRemoteLocationConstraintsSubnetLengthRange

class PortPairRemoteLocation(value)

Bases: proto.enums.Enum

[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.

Values:

UNDEFINED_PORT_PAIR_REMOTE_LOCATION (0):

A value indicating that the enum field is not set.

PORT_PAIR_MATCHING_REMOTE_LOCATION (207291859):

If PORT_PAIR_MATCHING_REMOTE_LOCATION, the remote cloud provider allocates ports in pairs, and the user should choose the same remote location for both ports.

PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION (60609829):

If PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, a user may opt to provision a redundant pair of Cross-Cloud Interconnects using two different remote locations in the same city.

class PortPairVlan(value)

Bases: proto.enums.Enum

[Output Only] Port pair VLAN constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN

Values:

UNDEFINED_PORT_PAIR_VLAN (0):

A value indicating that the enum field is not set.

PORT_PAIR_MATCHING_VLAN (250295358):

If PORT_PAIR_MATCHING_VLAN, the Interconnect for this attachment is part of a pair of ports that should have matching VLAN allocations. This occurs with Cross-Cloud Interconnect to Azure remote locations. While GCP’s API does not explicitly group pairs of ports, the UI uses this field to ensure matching VLAN ids when configuring a redundant VLAN pair.

PORT_PAIR_UNCONSTRAINED_VLAN (175227948):

PORT_PAIR_UNCONSTRAINED_VLAN means there is no constraint.

class google.cloud.compute_v1.types.InterconnectRemoteLocationConstraintsSubnetLengthRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

max_

This field is a member of oneof _max.

Type

int

min_

This field is a member of oneof _min.

Type

int

class google.cloud.compute_v1.types.InterconnectRemoteLocationList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to the list request, and contains a list of interconnect remote locations.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InterconnectRemoteLocation resources.

Type

MutableSequence[google.cloud.compute_v1.types.InterconnectRemoteLocation]

kind

[Output Only] Type of resource. Always compute#interconnectRemoteLocationList for lists of interconnect remote locations.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token lets you get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.InterconnectRemoteLocationPermittedConnections(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

interconnect_location

[Output Only] URL of an Interconnect location that is permitted to connect to this Interconnect remote location.

This field is a member of oneof _interconnect_location.

Type

str

class google.cloud.compute_v1.types.InterconnectsGetDiagnosticsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the InterconnectsGetDiagnosticsRequest.

result

This field is a member of oneof _result.

Type

google.cloud.compute_v1.types.InterconnectDiagnostics

class google.cloud.compute_v1.types.InterconnectsGetMacsecConfigResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the InterconnectsGetMacsecConfigRequest.

etag

end_interface: MixerGetResponseWithEtagBuilder

This field is a member of oneof _etag.

Type

str

result

This field is a member of oneof _result.

Type

google.cloud.compute_v1.types.InterconnectMacsecConfig

class google.cloud.compute_v1.types.InvalidateCacheUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.InvalidateCache. See the method description for details.

cache_invalidation_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.CacheInvalidationRule

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

url_map

Name of the UrlMap scoping this request.

Type

str

class google.cloud.compute_v1.types.Items(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata

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.

This field is a member of oneof _key.

Type

str

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).

This field is a member of oneof _value.

Type

str

class google.cloud.compute_v1.types.License(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

charges_use_fee

[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.

This field is a member of oneof _charges_use_fee.

Type

bool

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional textual description of the resource; provided by the client when the resource is created.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of resource. Always compute#license for licenses.

This field is a member of oneof _kind.

Type

str

license_code

[Output Only] The unique code used to attach this license to images, snapshots, and disks.

This field is a member of oneof _license_code.

Type

int

name

Name of the resource. The name must be 1-63 characters long and comply with RFC1035.

This field is a member of oneof _name.

Type

str

resource_requirements

This field is a member of oneof _resource_requirements.

Type

google.cloud.compute_v1.types.LicenseResourceRequirements

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

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.

This field is a member of oneof _transferable.

Type

bool

class google.cloud.compute_v1.types.LicenseCode(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a License Code resource. A License Code is a unique identifier used to represent a license resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

[Output Only] Description of this License Code.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of resource. Always compute#licenseCode for licenses.

This field is a member of oneof _kind.

Type

str

license_alias

[Output Only] URL and description aliases of Licenses with the same License Code.

Type

MutableSequence[google.cloud.compute_v1.types.LicenseCodeLicenseAlias]

name

[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.

This field is a member of oneof _name.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

state

[Output Only] Current state of this License Code. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

transferable

[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.

This field is a member of oneof _transferable.

Type

bool

class State(value)

Bases: proto.enums.Enum

[Output Only] Current state of this License Code.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

DISABLED (516696700):

Machines are not allowed to attach boot disks with this License Code. Requests to create new resources with this license will be rejected.

ENABLED (182130465):

Use is allowed for anyone with USE_READ_ONLY access to this License Code.

RESTRICTED (261551195):

Use of this license is limited to a project whitelist.

STATE_UNSPECIFIED (470755401):

No description available.

TERMINATED (250018339):

Reserved state.

class google.cloud.compute_v1.types.LicenseCodeLicenseAlias(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

description

[Output Only] Description of this License Code.

This field is a member of oneof _description.

Type

str

self_link

[Output Only] URL of license corresponding to this License Code.

This field is a member of oneof _self_link.

Type

str

class google.cloud.compute_v1.types.LicenseResourceCommitment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Commitment for a particular license resource.

amount

The number of licenses purchased.

This field is a member of oneof _amount.

Type

int

cores_per_license

Specifies the core range of the instance for which this license applies.

This field is a member of oneof _cores_per_license.

Type

str

license_

Any applicable license URI.

This field is a member of oneof _license.

Type

str

class google.cloud.compute_v1.types.LicenseResourceRequirements(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

min_guest_cpu_count

Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.

This field is a member of oneof _min_guest_cpu_count.

Type

int

min_memory_mb

Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.

This field is a member of oneof _min_memory_mb.

Type

int

class google.cloud.compute_v1.types.LicensesListResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of License resources.

Type

MutableSequence[google.cloud.compute_v1.types.License]

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ListAcceleratorTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for AcceleratorTypes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListAddressesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Addresses.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListAssociationsFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.ListAssociations. See the method description for details.

target_resource

The target resource to list associations. It is an organization, or a folder.

This field is a member of oneof _target_resource.

Type

str

class google.cloud.compute_v1.types.ListAutoscalersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Autoscalers.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListAvailableFeaturesRegionSslPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslPolicies.ListAvailableFeatures. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListAvailableFeaturesSslPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslPolicies.ListAvailableFeatures. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListBackendBucketsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListBackendServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListDiskTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for DiskTypes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListDisksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListDisksStoragePoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.ListDisks. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

storage_pool

Name of the storage pool to list disks of.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListErrorsInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.ListErrors. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group_manager

The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:a-z?)|1-9{0,19}.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the managed instance group is located. It should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.ListErrorsRegionInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.ListErrors. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group_manager

The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:a-z?)|1-9{0,19}.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request. This should conform to RFC1035.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListExternalVpnGatewaysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ExternalVpnGateways.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListFirewallPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

parent_id

Parent ID for this request. The ID can be either be “folders/[FOLDER_ID]” if the parent is a folder or “organizations/[ORGANIZATION_ID]” if the parent is an organization.

This field is a member of oneof _parent_id.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListFirewallsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Firewalls.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListForwardingRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ForwardingRules.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListGlobalAddressesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalAddresses.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListGlobalForwardingRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalForwardingRules.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListGlobalNetworkEndpointGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalNetworkEndpointGroups.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListGlobalOperationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalOperations.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListGlobalOrganizationOperationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalOrganizationOperations.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

parent_id

Parent ID for this request.

This field is a member of oneof _parent_id.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListGlobalPublicDelegatedPrefixesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalPublicDelegatedPrefixes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListHealthChecksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for HealthChecks.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListImagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListInstanceGroupManagerResizeRequestsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagerResizeRequests.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group_manager

The name of the managed instance group. The name should conform to RFC1035.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the managed instance group is located. The name should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.ListInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the managed instance group is located.

Type

str

class google.cloud.compute_v1.types.ListInstanceGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the instance group is located.

Type

str

class google.cloud.compute_v1.types.ListInstanceTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceTemplates.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListInstancesInstanceGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.ListInstances. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group

The name of the instance group from which you want to generate a list of included instances.

Type

str

instance_groups_list_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupsListInstancesRequest

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the instance group is located.

Type

str

class google.cloud.compute_v1.types.ListInstancesRegionInstanceGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroups.ListInstances. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group

Name of the regional instance group for which we want to list the instances.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_instance_groups_list_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupsListInstancesRequest

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListInstantSnapshotsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListInterconnectAttachmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectAttachments.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListInterconnectLocationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectLocations.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListInterconnectRemoteLocationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectRemoteLocations.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListInterconnectsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Interconnects.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListLicensesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Licenses.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListMachineImagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineImages.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListMachineTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineTypes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListManagedInstancesInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.ListManagedInstances. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group_manager

The name of the managed instance group.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the managed instance group is located.

Type

str

class google.cloud.compute_v1.types.ListManagedInstancesRegionInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.ListManagedInstances. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group_manager

The name of the managed instance group.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListNetworkAttachmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListNetworkEndpointGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the network endpoint group is located. It should comply with RFC1035.

Type

str

class google.cloud.compute_v1.types.ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalNetworkEndpointGroups.ListNetworkEndpoints. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

network_endpoint_group

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

str

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListNetworkEndpointsNetworkEndpointGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.ListNetworkEndpoints. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

network_endpoint_group

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

str

network_endpoint_groups_list_endpoints_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkEndpointGroupsListEndpointsRequest

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the network endpoint group is located. It should comply with RFC1035.

Type

str

class google.cloud.compute_v1.types.ListNetworkEndpointsRegionNetworkEndpointGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkEndpointGroups.ListNetworkEndpoints. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

network_endpoint_group

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

str

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region where the network endpoint group is located. It should comply with RFC1035.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListNetworkFirewallPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListNetworksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListNodeGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListNodeTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTemplates.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListNodeTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTypes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListNodesNodeGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.ListNodes. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

node_group

Name of the NodeGroup resource whose nodes you want to list.

Type

str

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListPacketMirroringsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PacketMirrorings.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListPeeringRoutesNetworksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.ListPeeringRoutes. See the method description for details.

direction

The direction of the exchanged routes. Check the Direction enum for the list of possible values.

This field is a member of oneof _direction.

Type

str

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

network

Name of the network for this request.

Type

str

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

peering_name

The response will show routes exchanged over the given peering connection.

This field is a member of oneof _peering_name.

Type

str

project

Project ID for this request.

Type

str

region

The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.

This field is a member of oneof _region.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class Direction(value)

Bases: proto.enums.Enum

The direction of the exchanged routes.

Values:

UNDEFINED_DIRECTION (0):

A value indicating that the enum field is not set.

INCOMING (338552870):

For routes exported from peer network.

OUTGOING (307438444):

For routes exported from local network.

class google.cloud.compute_v1.types.ListPerInstanceConfigsInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.ListPerInstanceConfigs. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone where the managed instance group is located. It should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.ListPerInstanceConfigsRegionInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.ListPerInstanceConfigs. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request, should conform to RFC1035.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListPreconfiguredExpressionSetsSecurityPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.ListPreconfiguredExpressionSets. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListPublicAdvertisedPrefixesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicAdvertisedPrefixes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListPublicDelegatedPrefixesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicDelegatedPrefixes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListReferrersInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.ListReferrers. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

instance

Name of the target instance scoping this request, or ‘-’ if the request should span over all instances in the container.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListRegionAutoscalersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionAutoscalers.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionBackendServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionCommitmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionCommitments.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionDiskTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDiskTypes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionDisksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionHealthCheckServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthCheckServices.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionHealthChecksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthChecks.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionInstanceGroupManagersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionInstanceGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroups.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionInstanceTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceTemplates.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

The name of the regions for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionInstantSnapshotsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstantSnapshots.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionNetworkEndpointGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkEndpointGroups.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region where the network endpoint group is located. It should comply with RFC1035.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionNetworkFirewallPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionNotificationEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNotificationEndpoints.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionOperationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionOperations.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionSecurityPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionSslCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslCertificates.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionSslPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslPolicies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionTargetHttpProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpProxies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionTargetHttpsProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpsProxies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionTargetTcpProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetTcpProxies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionUrlMapsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionUrlMaps.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionZonesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionZones.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRegionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Regions.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListReservationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListResourcePoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRoutersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListRoutesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListSecurityPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListServiceAttachmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region of this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListSnapshotsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Snapshots.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListSslCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslCertificates.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListSslPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslPolicies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListStoragePoolTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePoolTypes.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListStoragePoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ListSubnetworksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListTargetGrpcProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetGrpcProxies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListTargetHttpProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpProxies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListTargetHttpsProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListTargetInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetInstances.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

Name of the zone scoping this request.

Type

str

class google.cloud.compute_v1.types.ListTargetPoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListTargetSslProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListTargetTcpProxiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetTcpProxies.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListTargetVpnGatewaysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetVpnGateways.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListUrlMapsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListUsableBackendServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.ListUsable. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListUsableRegionBackendServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.ListUsable. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListUsableSubnetworksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.ListUsable. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListVpnGatewaysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnGateways.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListVpnTunnelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnTunnels.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListXpnHostsProjectsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.ListXpnHosts. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

projects_list_xpn_hosts_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ProjectsListXpnHostsRequest

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.ListZoneOperationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ZoneOperations.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

zone

Name of the zone for request.

Type

str

class google.cloud.compute_v1.types.ListZonesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Zones.List. See the method description for details.

filter

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

This field is a member of oneof _filter.

Type

str

max_results

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

This field is a member of oneof _max_results.

Type

int

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.

This field is a member of oneof _order_by.

Type

str

page_token

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

This field is a member of oneof _page_token.

Type

str

project

Project ID for this request.

Type

str

return_partial_success

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

This field is a member of oneof _return_partial_success.

Type

bool

class google.cloud.compute_v1.types.LocalDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

disk_count

Specifies the number of such disks.

This field is a member of oneof _disk_count.

Type

int

disk_size_gb

Specifies the size of the disk in base-2 GB.

This field is a member of oneof _disk_size_gb.

Type

int

disk_type

Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL.

This field is a member of oneof _disk_type.

Type

str

class google.cloud.compute_v1.types.LocalizedMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

locale

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: “en-US”, “fr-CH”, “es-MX”.

This field is a member of oneof _locale.

Type

str

message

The localized error message in the above locale.

This field is a member of oneof _message.

Type

str

class google.cloud.compute_v1.types.LocationPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).

locations

Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.

Type

MutableMapping[str, google.cloud.compute_v1.types.LocationPolicyLocation]

target_shape

Strategy for distributing VMs across zones in a region. Check the TargetShape enum for the list of possible values.

This field is a member of oneof _target_shape.

Type

str

class LocationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class TargetShape(value)

Bases: proto.enums.Enum

Strategy for distributing VMs across zones in a region.

Values:

UNDEFINED_TARGET_SHAPE (0):

A value indicating that the enum field is not set.

ANY (64972):

GCE picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.

ANY_SINGLE_ZONE (61100880):

GCE always selects a single zone for all the VMs, optimizing for resource quotas, available reservations and general capacity. Recommended for batch workloads that cannot tollerate distribution over multiple zones. This the default shape in Bulk Insert and Capacity Advisor APIs.

BALANCED (468409608):

GCE prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across allowed zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.

class google.cloud.compute_v1.types.LocationPolicyLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

constraints

Constraints that the caller requires on the result distribution in this zone.

This field is a member of oneof _constraints.

Type

google.cloud.compute_v1.types.LocationPolicyLocationConstraints

preference

Preference for a given location. Set to either ALLOW or DENY. Check the Preference enum for the list of possible values.

This field is a member of oneof _preference.

Type

str

class Preference(value)

Bases: proto.enums.Enum

Preference for a given location. Set to either ALLOW or DENY.

Values:

UNDEFINED_PREFERENCE (0):

A value indicating that the enum field is not set.

ALLOW (62368553):

Location is allowed for use.

DENY (2094604):

Location is prohibited.

PREFERENCE_UNSPECIFIED (496219571):

Default value, unused.

class google.cloud.compute_v1.types.LocationPolicyLocationConstraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Per-zone constraints on location policy for this zone.

max_count

Maximum number of items that are allowed to be placed in this zone. The value must be non-negative.

This field is a member of oneof _max_count.

Type

int

class google.cloud.compute_v1.types.MachineImage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.

creation_timestamp

[Output Only] The creation timestamp for this machine image in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

guest_flush

[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.

This field is a member of oneof _guest_flush.

Type

bool

id

[Output Only] A unique identifier for this machine image. The server defines this identifier.

This field is a member of oneof _id.

Type

int

instance_properties

[Output Only] Properties of source instance

This field is a member of oneof _instance_properties.

Type

google.cloud.compute_v1.types.InstanceProperties

kind

[Output Only] The resource type, which is always compute#machineImage for machine image.

This field is a member of oneof _kind.

Type

str

machine_image_encryption_key

Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.

This field is a member of oneof _machine_image_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

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.

This field is a member of oneof _name.

Type

str

satisfies_pzi

Output only. Reserved for future use.

This field is a member of oneof _satisfies_pzi.

Type

bool

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

saved_disks

An array of Machine Image specific properties for disks attached to the source instance

Type

MutableSequence[google.cloud.compute_v1.types.SavedDisk]

self_link

[Output Only] The URL for this machine image. The server defines this URL.

This field is a member of oneof _self_link.

Type

str

source_disk_encryption_keys

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

Type

MutableSequence[google.cloud.compute_v1.types.SourceDiskEncryptionKey]

source_instance

The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

This field is a member of oneof _source_instance.

Type

str

source_instance_properties

[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

This field is a member of oneof _source_instance_properties.

Type

google.cloud.compute_v1.types.SourceInstanceProperties

status

[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

storage_locations

The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

Type

MutableSequence[str]

total_storage_bytes

[Output Only] Total size of the storage used by the machine image.

This field is a member of oneof _total_storage_bytes.

Type

int

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

No description available.

DELETING (528602024):

No description available.

INVALID (530283991):

No description available.

READY (77848963):

No description available.

UPLOADING (267603489):

No description available.

class google.cloud.compute_v1.types.MachineImageList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of machine images.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of MachineImage resources.

Type

MutableSequence[google.cloud.compute_v1.types.MachineImage]

kind

[Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.MachineType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.

accelerators

[Output Only] A list of accelerator configurations assigned to this machine type.

Type

MutableSequence[google.cloud.compute_v1.types.Accelerators]

architecture

[Output Only] The architecture of the machine type. Check the Architecture enum for the list of possible values.

This field is a member of oneof _architecture.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

deprecated

[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable.

This field is a member of oneof _deprecated.

Type

google.cloud.compute_v1.types.DeprecationStatus

description

[Output Only] An optional textual description of the resource.

This field is a member of oneof _description.

Type

str

guest_cpus

[Output Only] The number of virtual CPUs that are available to the instance.

This field is a member of oneof _guest_cpus.

Type

int

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

image_space_gb

[Deprecated] This property is deprecated and will never be populated with any relevant values.

This field is a member of oneof _image_space_gb.

Type

int

is_shared_cpu

[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.

This field is a member of oneof _is_shared_cpu.

Type

bool

kind

[Output Only] The type of the resource. Always compute#machineType for machine types.

This field is a member of oneof _kind.

Type

str

maximum_persistent_disks

[Output Only] Maximum persistent disks allowed.

This field is a member of oneof _maximum_persistent_disks.

Type

int

maximum_persistent_disks_size_gb

[Output Only] Maximum total persistent disks size (GB) allowed.

This field is a member of oneof _maximum_persistent_disks_size_gb.

Type

int

memory_mb

[Output Only] The amount of physical memory available to the instance, defined in MB.

This field is a member of oneof _memory_mb.

Type

int

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

scratch_disks

[Output Only] A list of extended scratch disks assigned to the instance.

Type

MutableSequence[google.cloud.compute_v1.types.ScratchDisks]

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

zone

[Output Only] The name of the zone where the machine type resides, such as us-central1-a.

This field is a member of oneof _zone.

Type

str

class Architecture(value)

Bases: proto.enums.Enum

[Output Only] The architecture of the machine type.

Values:

UNDEFINED_ARCHITECTURE (0):

A value indicating that the enum field is not set.

ARCHITECTURE_UNSPECIFIED (394750507):

Default value indicating Architecture is not set.

ARM64 (62547450):

Machines with architecture ARM64

X86_64 (425300551):

Machines with architecture X86_64

class google.cloud.compute_v1.types.MachineTypeAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of MachineTypesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.MachineTypesScopedList]

kind

[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.MachineTypeList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of machine types.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of MachineType resources.

Type

MutableSequence[google.cloud.compute_v1.types.MachineType]

kind

[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.MachineTypesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

machine_types

[Output Only] A list of machine types contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.MachineType]

warning

[Output Only] An informational warning that appears when the machine types list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ManagedInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Managed Instance resource.

current_action

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group’s targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. Check the CurrentAction enum for the list of possible values.

This field is a member of oneof _current_action.

Type

str

id

[Output only] The unique identifier for this resource. This field is empty when instance does not exist.

This field is a member of oneof _id.

Type

int

instance

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

This field is a member of oneof _instance.

Type

str

instance_health

[Output Only] Health state of the instance per health-check.

Type

MutableSequence[google.cloud.compute_v1.types.ManagedInstanceInstanceHealth]

instance_status

[Output Only] The status of the instance. This field is empty when the instance does not exist. Check the InstanceStatus enum for the list of possible values.

This field is a member of oneof _instance_status.

Type

str

last_attempt

[Output Only] Information about the last attempt to create or delete the instance.

This field is a member of oneof _last_attempt.

Type

google.cloud.compute_v1.types.ManagedInstanceLastAttempt

name

[Output Only] The name of the instance. The name always exists even if the instance has not yet been created.

This field is a member of oneof _name.

Type

str

preserved_state_from_config

[Output Only] Preserved state applied from per-instance config for this instance.

This field is a member of oneof _preserved_state_from_config.

Type

google.cloud.compute_v1.types.PreservedState

preserved_state_from_policy

[Output Only] Preserved state generated based on stateful policy for this instance.

This field is a member of oneof _preserved_state_from_policy.

Type

google.cloud.compute_v1.types.PreservedState

properties_from_flexibility_policy

[Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy.

This field is a member of oneof _properties_from_flexibility_policy.

Type

google.cloud.compute_v1.types.ManagedInstancePropertiesFromFlexibilityPolicy

version

[Output Only] Intended version of this instance.

This field is a member of oneof _version.

Type

google.cloud.compute_v1.types.ManagedInstanceVersion

class CurrentAction(value)

Bases: proto.enums.Enum

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group’s targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. Additional supported values which may be not listed in the enum directly due to technical reasons: STOPPING SUSPENDING

Values:

UNDEFINED_CURRENT_ACTION (0):

A value indicating that the enum field is not set.

ABANDONING (388244813):

The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.

CREATING (455564985):

The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.

CREATING_WITHOUT_RETRIES (428843785):

The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group’s targetSize value is decreased.

DELETING (528602024):

The managed instance group is permanently deleting this instance.

NONE (2402104):

The managed instance group has not scheduled any actions for this instance.

RECREATING (287278572):

The managed instance group is recreating this instance.

REFRESHING (163266343):

The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.

RESTARTING (320534387):

The managed instance group is restarting this instance.

RESUMING (446856618):

The managed instance group is resuming this instance.

STARTING (488820800):

The managed instance group is starting this instance.

VERIFYING (16982185):

The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group’s autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions).

class InstanceStatus(value)

Bases: proto.enums.Enum

[Output Only] The status of the instance. This field is empty when the instance does not exist. Additional supported values which may be not listed in the enum directly due to technical reasons: STOPPING SUSPENDING

Values:

UNDEFINED_INSTANCE_STATUS (0):

A value indicating that the enum field is not set.

DEPROVISIONING (428935662):

The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.

PROVISIONING (290896621):

Resources are being allocated for the instance.

REPAIRING (413483285):

The instance is in repair.

RUNNING (121282975):

The instance is running.

STAGING (431072283):

All required resources have been allocated and the instance is being started.

STOPPED (444276141):

The instance has stopped successfully.

STOPPING (350791796):

No description available.

SUSPENDED (51223995):

The instance has suspended.

SUSPENDING (514206246):

No description available.

TERMINATED (250018339):

The instance has stopped (either by explicit action or underlying failure).

class google.cloud.compute_v1.types.ManagedInstanceInstanceHealth(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

detailed_health_state

[Output Only] The current detailed instance health state. Check the DetailedHealthState enum for the list of possible values.

This field is a member of oneof _detailed_health_state.

Type

str

health_check

[Output Only] The URL for the health check that verifies whether the instance is healthy.

This field is a member of oneof _health_check.

Type

str

class DetailedHealthState(value)

Bases: proto.enums.Enum

[Output Only] The current detailed instance health state.

Values:

UNDEFINED_DETAILED_HEALTH_STATE (0):

A value indicating that the enum field is not set.

DRAINING (480455402):

The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.

HEALTHY (439801213):

The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.

TIMEOUT (477813057):

The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.

UNHEALTHY (462118084):

The instance is reachable, but does not conform to the requirements defined by the health check.

UNKNOWN (433141802):

The health checking system is aware of the instance but its health is not known at the moment.

class google.cloud.compute_v1.types.ManagedInstanceLastAttempt(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

errors

[Output Only] Encountered errors during the last attempt to create or delete the instance.

This field is a member of oneof _errors.

Type

google.cloud.compute_v1.types.Errors

class google.cloud.compute_v1.types.ManagedInstancePropertiesFromFlexibilityPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

machine_type

The machine type to be used for this instance.

This field is a member of oneof _machine_type.

Type

str

class google.cloud.compute_v1.types.ManagedInstanceVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_template

[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

This field is a member of oneof _instance_template.

Type

str

name

[Output Only] Name of the version.

This field is a member of oneof _name.

Type

str

class google.cloud.compute_v1.types.Metadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A metadata key/value entry.

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. To see the latest fingerprint, make a get() request to retrieve the resource.

This field is a member of oneof _fingerprint.

Type

str

items

Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

Type

MutableSequence[google.cloud.compute_v1.types.Items]

kind

[Output Only] Type of the resource. Always compute#metadata for metadata.

This field is a member of oneof _kind.

Type

str

class google.cloud.compute_v1.types.MetadataFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.

filter_labels

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Type

MutableSequence[google.cloud.compute_v1.types.MetadataFilterLabelMatch]

filter_match_criteria

Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata. Check the FilterMatchCriteria enum for the list of possible values.

This field is a member of oneof _filter_match_criteria.

Type

str

class FilterMatchCriteria(value)

Bases: proto.enums.Enum

Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.

Values:

UNDEFINED_FILTER_MATCH_CRITERIA (0):

A value indicating that the enum field is not set.

MATCH_ALL (180663271):

Specifies that all filterLabels must match for the metadataFilter to be considered a match.

MATCH_ANY (180663346):

Specifies that any filterLabel must match for the metadataFilter to be considered a match.

NOT_SET (163646646):

Indicates that the match criteria was not set. A metadataFilter must never be created with this value.

class google.cloud.compute_v1.types.MetadataFilterLabelMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer.

name

Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

This field is a member of oneof _name.

Type

str

value

The value of the label must match the specified value. value can have a maximum length of 1024 characters.

This field is a member of oneof _value.

Type

str

class google.cloud.compute_v1.types.MoveAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Addresses.Move. See the method description for details.

address

Name of the address resource to move.

Type

str

project

Source project ID which the Address is moved from.

Type

str

region

Name of the region for this request.

Type

str

region_addresses_move_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionAddressesMoveRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.MoveDiskProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.MoveDisk. See the method description for details.

disk_move_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DiskMoveRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.MoveFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.Move. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

parent_id

The new parent of the firewall policy. The ID can be either be “folders/[FOLDER_ID]” if the parent is a folder or “organizations/[ORGANIZATION_ID]” if the parent is an organization.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.MoveGlobalAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalAddresses.Move. See the method description for details.

address

Name of the address resource to move.

Type

str

global_addresses_move_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalAddressesMoveRequest

project

Source project ID which the Address is moved from.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.MoveInstanceProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.MoveInstance. See the method description for details.

instance_move_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceMoveRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.NamedPort(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The named port. For example: <”http”, 80>.

name

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

This field is a member of oneof _name.

Type

str

port

The port number, which can be a value between 1 and 65535.

This field is a member of oneof _port.

Type

int

class google.cloud.compute_v1.types.NatIpInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains NAT IP information of a NAT config (i.e. usage status, mode).

nat_ip_info_mappings

A list of all NAT IPs assigned to this NAT config.

Type

MutableSequence[google.cloud.compute_v1.types.NatIpInfoNatIpInfoMapping]

nat_name

Name of the NAT config which the NAT IP belongs to.

This field is a member of oneof _nat_name.

Type

str

class google.cloud.compute_v1.types.NatIpInfoNatIpInfoMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains information of a NAT IP.

mode

Specifies whether NAT IP is auto or manual. Check the Mode enum for the list of possible values.

This field is a member of oneof _mode.

Type

str

nat_ip

NAT IP address. For example: 203.0.113.11.

This field is a member of oneof _nat_ip.

Type

str

usage

Specifies whether NAT IP is currently serving at least one endpoint or not. Check the Usage enum for the list of possible values.

This field is a member of oneof _usage.

Type

str

class Mode(value)

Bases: proto.enums.Enum

Specifies whether NAT IP is auto or manual.

Values:

UNDEFINED_MODE (0):

A value indicating that the enum field is not set.

AUTO (2020783):

No description available.

MANUAL (119397318):

No description available.

class Usage(value)

Bases: proto.enums.Enum

Specifies whether NAT IP is currently serving at least one endpoint or not.

Values:

UNDEFINED_USAGE (0):

A value indicating that the enum field is not set.

IN_USE (17393485):

No description available.

UNUSED (360643030):

No description available.

class google.cloud.compute_v1.types.NatIpInfoResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

result

[Output Only] A list of NAT IP information.

Type

MutableSequence[google.cloud.compute_v1.types.NatIpInfo]

class google.cloud.compute_v1.types.Network(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.

I_pv4_range

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.

This field is a member of oneof _I_pv4_range.

Type

str

auto_create_subnetworks

Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.

This field is a member of oneof _auto_create_subnetworks.

Type

bool

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this field when you create the resource.

This field is a member of oneof _description.

Type

str

enable_ula_internal_ipv6

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .

This field is a member of oneof _enable_ula_internal_ipv6.

Type

bool

firewall_policy

[Output Only] URL of the firewall policy the network is associated with.

This field is a member of oneof _firewall_policy.

Type

str

gateway_i_pv4

[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.

This field is a member of oneof _gateway_i_pv4.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

internal_ipv6_range

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .

This field is a member of oneof _internal_ipv6_range.

Type

str

kind

[Output Only] Type of the resource. Always compute#network for networks.

This field is a member of oneof _kind.

Type

str

mtu

Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.

This field is a member of oneof _mtu.

Type

int

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.

This field is a member of oneof _name.

Type

str

network_firewall_policy_enforcement_order

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. Check the NetworkFirewallPolicyEnforcementOrder enum for the list of possible values.

This field is a member of oneof _network_firewall_policy_enforcement_order.

Type

str

peerings

[Output Only] A list of network peerings for the resource.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkPeering]

routing_config

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.

This field is a member of oneof _routing_config.

Type

google.cloud.compute_v1.types.NetworkRoutingConfig

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

self_link_with_id

[Output Only] Server-defined URL for this resource with the resource id.

This field is a member of oneof _self_link_with_id.

Type

str

subnetworks

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

Type

MutableSequence[str]

class NetworkFirewallPolicyEnforcementOrder(value)

Bases: proto.enums.Enum

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.

Values:

UNDEFINED_NETWORK_FIREWALL_POLICY_ENFORCEMENT_ORDER (0):

A value indicating that the enum field is not set.

AFTER_CLASSIC_FIREWALL (154582608):

No description available.

BEFORE_CLASSIC_FIREWALL (338458349):

No description available.

class google.cloud.compute_v1.types.NetworkAttachment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

NetworkAttachments A network attachment resource …

connection_endpoints

[Output Only] An array of connections for all the producers connected to this network attachment.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkAttachmentConnectedEndpoint]

connection_preference

Check the ConnectionPreference enum for the list of possible values.

This field is a member of oneof _connection_preference.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

fingerprint

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource type. The server generates this identifier.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

network

[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.

This field is a member of oneof _network.

Type

str

producer_accept_lists

Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.

Type

MutableSequence[str]

producer_reject_lists

Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.

Type

MutableSequence[str]

region

[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

self_link_with_id

[Output Only] Server-defined URL for this resource’s resource id.

This field is a member of oneof _self_link_with_id.

Type

str

subnetworks

An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.

Type

MutableSequence[str]

class ConnectionPreference(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_CONNECTION_PREFERENCE (0):

A value indicating that the enum field is not set.

ACCEPT_AUTOMATIC (75250580):

No description available.

ACCEPT_MANUAL (373061341):

No description available.

INVALID (530283991):

No description available.

class google.cloud.compute_v1.types.NetworkAttachmentAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of NetworkAttachmentsScopedList.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NetworkAttachmentsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.NetworkAttachmentsScopedList]

kind

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.NetworkAttachmentConnectedEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] A connection connected to this network attachment.

ip_address

The IPv4 address assigned to the producer instance network interface. This value will be a range in case of Serverless.

This field is a member of oneof _ip_address.

Type

str

ipv6_address

The IPv6 address assigned to the producer instance network interface. This is only assigned when the stack types of both the instance network interface and the consumer subnet are IPv4_IPv6.

This field is a member of oneof _ipv6_address.

Type

str

project_id_or_num

The project id or number of the interface to which the IP was assigned.

This field is a member of oneof _project_id_or_num.

Type

str

secondary_ip_cidr_ranges

Alias IP ranges from the same subnetwork.

Type

MutableSequence[str]

status

The status of a connected endpoint to this network attachment. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

subnetwork

The subnetwork used to assign the IP to the producer instance network interface.

This field is a member of oneof _subnetwork.

Type

str

subnetwork_cidr_range

[Output Only] The CIDR range of the subnet from which the IPv4 internal IP was allocated from.

This field is a member of oneof _subnetwork_cidr_range.

Type

str

class Status(value)

Bases: proto.enums.Enum

The status of a connected endpoint to this network attachment.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ACCEPTED (246714279):

The consumer allows traffic from the producer to reach its VPC.

CLOSED (380163436):

The consumer network attachment no longer exists.

NEEDS_ATTENTION (344491452):

The consumer needs to take further action before traffic can be served.

PENDING (35394935):

The consumer neither allows nor prohibits traffic from the producer to reach its VPC.

REJECTED (174130302):

The consumer prohibits traffic from the producer to reach its VPC.

STATUS_UNSPECIFIED (42133066):

No description available.

class google.cloud.compute_v1.types.NetworkAttachmentList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NetworkAttachment resources.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkAttachment]

kind

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NetworkAttachmentsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_attachments

A list of NetworkAttachments contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkAttachment]

warning

Informational warning which replaces the list of network attachments when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NetworkEdgeSecurityService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Google Cloud Armor network edge security service resource.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

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 NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

region

[Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _region.

Type

str

security_policy

The resource URL for the network edge security service associated with this network edge security service.

This field is a member of oneof _security_policy.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

self_link_with_id

[Output Only] Server-defined URL for this resource with the resource id.

This field is a member of oneof _self_link_with_id.

Type

str

class google.cloud.compute_v1.types.NetworkEdgeSecurityServiceAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

etag

This field is a member of oneof _etag.

Type

str

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NetworkEdgeSecurityServicesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.NetworkEdgeSecurityServicesScopedList]

kind

[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.NetworkEdgeSecurityServicesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_edge_security_services

A list of NetworkEdgeSecurityServices contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEdgeSecurityService]

warning

Informational warning which replaces the list of security policies when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NetworkEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The network endpoint.

annotations

Metadata defined as annotations on the network endpoint.

Type

MutableMapping[str, str]

client_destination_port

Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.

This field is a member of oneof _client_destination_port.

Type

int

fqdn

Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.

This field is a member of oneof _fqdn.

Type

str

instance

The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.

This field is a member of oneof _instance.

Type

str

ip_address

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. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.

This field is a member of oneof _ip_address.

Type

str

ipv6_address

Optional IPv6 address of network endpoint.

This field is a member of oneof _ipv6_address.

Type

str

port

Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.

This field is a member of oneof _port.

Type

int

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.NetworkEndpointGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.

annotations

Metadata defined as annotations on the network endpoint group.

Type

MutableMapping[str, str]

app_engine

Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.

This field is a member of oneof _app_engine.

Type

google.cloud.compute_v1.types.NetworkEndpointGroupAppEngine

cloud_function

Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.

This field is a member of oneof _cloud_function.

Type

google.cloud.compute_v1.types.NetworkEndpointGroupCloudFunction

cloud_run

Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.

This field is a member of oneof _cloud_run.

Type

google.cloud.compute_v1.types.NetworkEndpointGroupCloudRun

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

default_port

The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.

This field is a member of oneof _default_port.

Type

int

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

network

The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.

This field is a member of oneof _network.

Type

str

network_endpoint_type

Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. Check the NetworkEndpointType enum for the list of possible values.

This field is a member of oneof _network_endpoint_type.

Type

str

psc_data

This field is a member of oneof _psc_data.

Type

google.cloud.compute_v1.types.NetworkEndpointGroupPscData

psc_target_service

The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com

This field is a member of oneof _psc_target_service.

Type

str

region

[Output Only] The URL of the region where the network endpoint group is located.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

size

[Output only] Number of network endpoints in the network endpoint group.

This field is a member of oneof _size.

Type

int

subnetwork

Optional URL of the subnetwork to which all network endpoints in the NEG belong.

This field is a member of oneof _subnetwork.

Type

str

zone

[Output Only] The URL of the zone where the network endpoint group is located.

This field is a member of oneof _zone.

Type

str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class NetworkEndpointType(value)

Bases: proto.enums.Enum

Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.

Values:

UNDEFINED_NETWORK_ENDPOINT_TYPE (0):

A value indicating that the enum field is not set.

GCE_VM_IP (401880793):

The network endpoint is represented by an IP address.

GCE_VM_IP_PORT (501838375):

The network endpoint is represented by IP address and port pair.

GCE_VM_IP_PORTMAP (22819253):

The network endpoint is represented by an IP, Port and Client Destination Port.

INTERNET_FQDN_PORT (404154477):

The network endpoint is represented by fully qualified domain name and port.

INTERNET_IP_PORT (477719963):

The network endpoint is represented by an internet IP address and port.

NON_GCP_PRIVATE_IP_PORT (336447968):

The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer’s on-premises.

PRIVATE_SERVICE_CONNECT (48134724):

The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect

SERVERLESS (270492508):

The network endpoint is handled by specified serverless infrastructure.

class google.cloud.compute_v1.types.NetworkEndpointGroupAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NetworkEndpointGroupsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.NetworkEndpointGroupsScopedList]

kind

[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.NetworkEndpointGroupAppEngine(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.

service

Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.

This field is a member of oneof _service.

Type

str

url_mask

An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = “foo1”, version = “v1” } and { service = “foo1”, version = “v2” } respectively.

This field is a member of oneof _url_mask.

Type

str

version

Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.

This field is a member of oneof _version.

Type

str

class google.cloud.compute_v1.types.NetworkEndpointGroupCloudFunction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.

function

A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.

This field is a member of oneof _function.

Type

str

url_mask

An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = “function1” } and { function = “function2” } respectively.

This field is a member of oneof _url_mask.

Type

str

class google.cloud.compute_v1.types.NetworkEndpointGroupCloudRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.

service

Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: “run-service”.

This field is a member of oneof _service.

Type

str

tag

Optional Cloud Run tag represents the “named-revision” to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: “revision-0010”.

This field is a member of oneof _tag.

Type

str

url_mask

An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service=”bar1”, tag=”foo1” } and { service=”bar2”, tag=”foo2” } respectively.

This field is a member of oneof _url_mask.

Type

str

class google.cloud.compute_v1.types.NetworkEndpointGroupList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NetworkEndpointGroup resources.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpointGroup]

kind

[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NetworkEndpointGroupPscData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.

consumer_psc_address

[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.

This field is a member of oneof _consumer_psc_address.

Type

str

producer_port

The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type

This field is a member of oneof _producer_port.

Type

int

psc_connection_id

[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.

This field is a member of oneof _psc_connection_id.

Type

int

psc_connection_status

[Output Only] The connection status of the PSC Forwarding Rule. Check the PscConnectionStatus enum for the list of possible values.

This field is a member of oneof _psc_connection_status.

Type

str

class PscConnectionStatus(value)

Bases: proto.enums.Enum

[Output Only] The connection status of the PSC Forwarding Rule.

Values:

UNDEFINED_PSC_CONNECTION_STATUS (0):

A value indicating that the enum field is not set.

ACCEPTED (246714279):

The connection has been accepted by the producer.

CLOSED (380163436):

The connection has been closed by the producer and will not serve traffic going forward.

NEEDS_ATTENTION (344491452):

The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.

PENDING (35394935):

The connection is pending acceptance by the producer.

REJECTED (174130302):

The connection has been rejected by the producer.

STATUS_UNSPECIFIED (42133066):

No description available.

class google.cloud.compute_v1.types.NetworkEndpointGroupsAttachEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_endpoints

The list of network endpoints to be attached.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpoint]

class google.cloud.compute_v1.types.NetworkEndpointGroupsDetachEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_endpoints

The list of network endpoints to be detached.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpoint]

class google.cloud.compute_v1.types.NetworkEndpointGroupsListEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

health_status

Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don’t specify this parameter, the health status of network endpoints will not be provided. Check the HealthStatus enum for the list of possible values.

This field is a member of oneof _health_status.

Type

str

class HealthStatus(value)

Bases: proto.enums.Enum

Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don’t specify this parameter, the health status of network endpoints will not be provided.

Values:

UNDEFINED_HEALTH_STATUS (0):

A value indicating that the enum field is not set.

SHOW (2544381):

Show the health status for each network endpoint. Impacts latency of the call.

SKIP (2547071):

Health status for network endpoints will not be provided.

class google.cloud.compute_v1.types.NetworkEndpointGroupsListNetworkEndpoints(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NetworkEndpointWithHealthStatus resources.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpointWithHealthStatus]

kind

[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NetworkEndpointGroupsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_endpoint_groups

[Output Only] The list of network endpoint groups that are contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpointGroup]

warning

[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NetworkEndpointWithHealthStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

healths

[Output only] The health status of network endpoint;

Type

MutableSequence[google.cloud.compute_v1.types.HealthStatusForNetworkEndpoint]

network_endpoint

[Output only] The network endpoint;

This field is a member of oneof _network_endpoint.

Type

google.cloud.compute_v1.types.NetworkEndpoint

class google.cloud.compute_v1.types.NetworkInterface(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A network interface resource attached to an instance.

access_configs

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

Type

MutableSequence[google.cloud.compute_v1.types.AccessConfig]

alias_ip_ranges

An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

Type

MutableSequence[google.cloud.compute_v1.types.AliasIpRange]

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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

This field is a member of oneof _fingerprint.

Type

str

internal_ipv6_prefix_length

The prefix length of the primary internal IPv6 range.

This field is a member of oneof _internal_ipv6_prefix_length.

Type

int

ipv6_access_configs

An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

Type

MutableSequence[google.cloud.compute_v1.types.AccessConfig]

ipv6_access_type

[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. Check the Ipv6AccessType enum for the list of possible values.

This field is a member of oneof _ipv6_access_type.

Type

str

ipv6_address

An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance’s zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance’s subnetwork.

This field is a member of oneof _ipv6_address.

Type

str

kind

[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

This field is a member of oneof _kind.

Type

str

name

[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.

This field is a member of oneof _name.

Type

str

network

URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn’t have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

This field is a member of oneof _network.

Type

str

network_attachment

The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.

This field is a member of oneof _network_attachment.

Type

str

network_i_p

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.

This field is a member of oneof _network_i_p.

Type

str

nic_type

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Check the NicType enum for the list of possible values.

This field is a member of oneof _nic_type.

Type

str

queue_count

The networking queue count that’s specified by users for the network interface. Both Rx and Tx queues will be set to this number. It’ll be empty if not specified by the users.

This field is a member of oneof _queue_count.

Type

int

stack_type

The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations. Check the StackType enum for the list of possible values.

This field is a member of oneof _stack_type.

Type

str

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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

This field is a member of oneof _subnetwork.

Type

str

class Ipv6AccessType(value)

Bases: proto.enums.Enum

[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.

Values:

UNDEFINED_IPV6_ACCESS_TYPE (0):

A value indicating that the enum field is not set.

EXTERNAL (35607499):

This network interface can have external IPv6.

INTERNAL (279295677):

This network interface can have internal IPv6.

UNSPECIFIED_IPV6_ACCESS_TYPE (313080613):

No description available.

class NicType(value)

Bases: proto.enums.Enum

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Values:

UNDEFINED_NIC_TYPE (0):

A value indicating that the enum field is not set.

GVNIC (68209305):

GVNIC

IDPF (2242641):

IDPF

UNSPECIFIED_NIC_TYPE (67411801):

No type specified.

VIRTIO_NET (452123481):

VIRTIO

class StackType(value)

Bases: proto.enums.Enum

The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.

Values:

UNDEFINED_STACK_TYPE (0):

A value indicating that the enum field is not set.

IPV4_IPV6 (22197249):

The network interface can have both IPv4 and IPv6 addresses.

IPV4_ONLY (22373798):

The network interface will only be assigned IPv4 addresses.

IPV6_ONLY (79632100):

The network interface will only be assigned IPv6 addresses.

UNSPECIFIED_STACK_TYPE (298084569):

No description available.

class google.cloud.compute_v1.types.NetworkList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of networks.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Network resources.

Type

MutableSequence[google.cloud.compute_v1.types.Network]

kind

[Output Only] Type of resource. Always compute#networkList for lists of networks.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NetworkPeering(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.

auto_create_routes

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.

This field is a member of oneof _auto_create_routes.

Type

bool

exchange_subnet_routes

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.

This field is a member of oneof _exchange_subnet_routes.

Type

bool

export_custom_routes

Whether to export the custom routes to peer network. The default value is false.

This field is a member of oneof _export_custom_routes.

Type

bool

export_subnet_routes_with_public_ip

Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.

This field is a member of oneof _export_subnet_routes_with_public_ip.

Type

bool

import_custom_routes

Whether to import the custom routes from peer network. The default value is false.

This field is a member of oneof _import_custom_routes.

Type

bool

import_subnet_routes_with_public_ip

Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.

This field is a member of oneof _import_subnet_routes_with_public_ip.

Type

bool

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.

This field is a member of oneof _name.

Type

str

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.

This field is a member of oneof _network.

Type

str

peer_mtu

Maximum Transmission Unit in bytes.

This field is a member of oneof _peer_mtu.

Type

int

stack_type

Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. Check the StackType enum for the list of possible values.

This field is a member of oneof _stack_type.

Type

str

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. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

state_details

[Output Only] Details about the current state of the peering.

This field is a member of oneof _state_details.

Type

str

class StackType(value)

Bases: proto.enums.Enum

Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.

Values:

UNDEFINED_STACK_TYPE (0):

A value indicating that the enum field is not set.

IPV4_IPV6 (22197249):

This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.

IPV4_ONLY (22373798):

This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.

class State(value)

Bases: proto.enums.Enum

[Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there’s a matching configuration in the peer network.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

Matching configuration exists on the peer.

INACTIVE (270421099):

There is no matching configuration on the peer, including the case when peer does not exist.

class google.cloud.compute_v1.types.NetworkPerformanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

total_egress_bandwidth_tier

Check the TotalEgressBandwidthTier enum for the list of possible values.

This field is a member of oneof _total_egress_bandwidth_tier.

Type

str

class TotalEgressBandwidthTier(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_TOTAL_EGRESS_BANDWIDTH_TIER (0):

A value indicating that the enum field is not set.

DEFAULT (115302945):

No description available.

TIER_1 (326919444):

No description available.

class google.cloud.compute_v1.types.NetworkRoutingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.

routing_mode

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. Check the RoutingMode enum for the list of possible values.

This field is a member of oneof _routing_mode.

Type

str

class RoutingMode(value)

Bases: proto.enums.Enum

The network-wide routing mode to use. If set to REGIONAL, this network’s Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network’s Cloud Routers will advertise routes with all subnets of this network, across regions.

Values:

UNDEFINED_ROUTING_MODE (0):

A value indicating that the enum field is not set.

GLOBAL (494663587):

No description available.

REGIONAL (92288543):

No description available.

class google.cloud.compute_v1.types.NetworksAddPeeringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

auto_create_routes

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.

This field is a member of oneof _auto_create_routes.

Type

bool

name

Name of the peering, which should conform to RFC1035.

This field is a member of oneof _name.

Type

str

network_peering

Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon.

This field is a member of oneof _network_peering.

Type

google.cloud.compute_v1.types.NetworkPeering

peer_network

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.

This field is a member of oneof _peer_network.

Type

str

class google.cloud.compute_v1.types.NetworksGetEffectiveFirewallsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

firewall_policys

[Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well.

Type

MutableSequence[google.cloud.compute_v1.types.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy]

firewalls

Effective firewalls on the network.

Type

MutableSequence[google.cloud.compute_v1.types.Firewall]

class google.cloud.compute_v1.types.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

display_name

[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.

This field is a member of oneof _display_name.

Type

str

name

[Output Only] The name of the firewall policy.

This field is a member of oneof _name.

Type

str

priority

[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.

This field is a member of oneof _priority.

Type

int

rules

[Output Only] The rules that apply to the network.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyRule]

short_name

[Output Only] The short name of the firewall policy.

This field is a member of oneof _short_name.

Type

str

type_

[Output Only] The type of the firewall policy. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

[Output Only] The type of the firewall policy.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

HIERARCHY (69902869):

No description available.

NETWORK (413984270):

No description available.

SYSTEM (313484847):

No description available.

UNSPECIFIED (526786327):

No description available.

class google.cloud.compute_v1.types.NetworksRemovePeeringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

name

Name of the peering, which should conform to RFC1035.

This field is a member of oneof _name.

Type

str

class google.cloud.compute_v1.types.NetworksUpdatePeeringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_peering

This field is a member of oneof _network_peering.

Type

google.cloud.compute_v1.types.NetworkPeering

class google.cloud.compute_v1.types.NodeGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.

autoscaling_policy

Specifies how autoscaling should behave.

This field is a member of oneof _autoscaling_policy.

Type

google.cloud.compute_v1.types.NodeGroupAutoscalingPolicy

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

fingerprint

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] The type of the resource. Always compute#nodeGroup for node group.

This field is a member of oneof _kind.

Type

str

location_hint

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

This field is a member of oneof _location_hint.

Type

str

maintenance_interval

Specifies the frequency of planned maintenance events. The accepted values are: AS_NEEDED and RECURRENT. Check the MaintenanceInterval enum for the list of possible values.

This field is a member of oneof _maintenance_interval.

Type

str

maintenance_policy

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. Check the MaintenancePolicy enum for the list of possible values.

This field is a member of oneof _maintenance_policy.

Type

str

maintenance_window

This field is a member of oneof _maintenance_window.

Type

google.cloud.compute_v1.types.NodeGroupMaintenanceWindow

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.

This field is a member of oneof _name.

Type

str

node_template

URL of the node template to create the node group from.

This field is a member of oneof _node_template.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

share_settings

Share-settings for the node group

This field is a member of oneof _share_settings.

Type

google.cloud.compute_v1.types.ShareSettings

size

[Output Only] The total number of nodes in the node group.

This field is a member of oneof _size.

Type

int

status

Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

zone

[Output Only] The name of the zone where the node group resides, such as us-central1-a.

This field is a member of oneof _zone.

Type

str

class MaintenanceInterval(value)

Bases: proto.enums.Enum

Specifies the frequency of planned maintenance events. The accepted values are: AS_NEEDED and RECURRENT.

Values:

UNDEFINED_MAINTENANCE_INTERVAL (0):

A value indicating that the enum field is not set.

AS_NEEDED (500724834):

VMs are eligible to receive infrastructure and hypervisor updates as they become available. This may result in more maintenance operations (live migrations or terminations) for the VM than the PERIODIC and RECURRENT options.

RECURRENT (194244550):

VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available. RECURRENT is used for GEN3 and Slice of Hardware VMs.

class MaintenancePolicy(value)

Bases: proto.enums.Enum

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

Values:

UNDEFINED_MAINTENANCE_POLICY (0):

A value indicating that the enum field is not set.

DEFAULT (115302945):

Allow the node and corresponding instances to retain default maintenance behavior.

MAINTENANCE_POLICY_UNSPECIFIED (72964182):

No description available.

MIGRATE_WITHIN_NODE_GROUP (153483394):

When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.

RESTART_IN_PLACE (228647325):

Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.

class Status(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

No description available.

DELETING (528602024):

No description available.

INVALID (530283991):

No description available.

READY (77848963):

No description available.

class google.cloud.compute_v1.types.NodeGroupAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NodeGroupsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.NodeGroupsScopedList]

kind

[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.NodeGroupAutoscalingPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

max_nodes

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

This field is a member of oneof _max_nodes.

Type

int

min_nodes

The minimum number of nodes that the group should have.

This field is a member of oneof _min_nodes.

Type

int

mode

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes. Check the Mode enum for the list of possible values.

This field is a member of oneof _mode.

Type

str

class Mode(value)

Bases: proto.enums.Enum

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

Values:

UNDEFINED_MODE (0):

A value indicating that the enum field is not set.

MODE_UNSPECIFIED (371348091):

No description available.

OFF (78159):

Autoscaling is disabled.

ON (2527):

Autocaling is fully enabled.

ONLY_SCALE_OUT (152713670):

Autoscaling will only scale out and will not remove nodes.

class google.cloud.compute_v1.types.NodeGroupList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of nodeGroups.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NodeGroup resources.

Type

MutableSequence[google.cloud.compute_v1.types.NodeGroup]

kind

[Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NodeGroupMaintenanceWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Time window specified for daily maintenance operations. GCE’s internal maintenance will be performed within this window.

maintenance_duration

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

This field is a member of oneof _maintenance_duration.

Type

google.cloud.compute_v1.types.Duration

start_time

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.

This field is a member of oneof _start_time.

Type

str

class google.cloud.compute_v1.types.NodeGroupNode(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

accelerators

Accelerators for this node.

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorConfig]

consumed_resources

Node resources that are reserved by all instances.

This field is a member of oneof _consumed_resources.

Type

google.cloud.compute_v1.types.InstanceConsumptionInfo

cpu_overcommit_type

CPU overcommit. Check the CpuOvercommitType enum for the list of possible values.

This field is a member of oneof _cpu_overcommit_type.

Type

str

disks

Local disk configurations.

Type

MutableSequence[google.cloud.compute_v1.types.LocalDisk]

instance_consumption_data

Instance data that shows consumed resources on the node.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceConsumptionData]

instances

Instances scheduled on this node.

Type

MutableSequence[str]

name

The name of the node.

This field is a member of oneof _name.

Type

str

node_type

The type of this node.

This field is a member of oneof _node_type.

Type

str

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

server_binding

Binding properties for the physical server.

This field is a member of oneof _server_binding.

Type

google.cloud.compute_v1.types.ServerBinding

server_id

Server ID associated with this node.

This field is a member of oneof _server_id.

Type

str

status

Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

total_resources

Total amount of available resources on the node.

This field is a member of oneof _total_resources.

Type

google.cloud.compute_v1.types.InstanceConsumptionInfo

upcoming_maintenance

[Output Only] The information about an upcoming maintenance event.

This field is a member of oneof _upcoming_maintenance.

Type

google.cloud.compute_v1.types.UpcomingMaintenance

class CpuOvercommitType(value)

Bases: proto.enums.Enum

CPU overcommit.

Values:

UNDEFINED_CPU_OVERCOMMIT_TYPE (0):

A value indicating that the enum field is not set.

CPU_OVERCOMMIT_TYPE_UNSPECIFIED (520665615):

No description available.

ENABLED (182130465):

No description available.

NONE (2402104):

No description available.

class Status(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

No description available.

DELETING (528602024):

No description available.

INVALID (530283991):

No description available.

READY (77848963):

No description available.

REPAIRING (413483285):

No description available.

class google.cloud.compute_v1.types.NodeGroupsAddNodesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

additional_node_count

Count of additional nodes to be added to the node group.

This field is a member of oneof _additional_node_count.

Type

int

class google.cloud.compute_v1.types.NodeGroupsDeleteNodesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

nodes

Names of the nodes to delete.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.NodeGroupsListNodes(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Node resources.

Type

MutableSequence[google.cloud.compute_v1.types.NodeGroupNode]

kind

[Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NodeGroupsPerformMaintenanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

nodes

[Required] List of nodes affected by the call.

Type

MutableSequence[str]

start_time

The start time of the schedule. The timestamp is an RFC3339 string.

This field is a member of oneof _start_time.

Type

str

class google.cloud.compute_v1.types.NodeGroupsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

node_groups

[Output Only] A list of node groups contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.NodeGroup]

warning

[Output Only] An informational warning that appears when the nodeGroup list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NodeGroupsSetNodeTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

node_template

Full or partial URL of the node template resource to be updated for this node group.

This field is a member of oneof _node_template.

Type

str

class google.cloud.compute_v1.types.NodeGroupsSimulateMaintenanceEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

nodes

Names of the nodes to go under maintenance simulation.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.NodeTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

accelerators

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorConfig]

cpu_overcommit_type

CPU overcommit. Check the CpuOvercommitType enum for the list of possible values.

This field is a member of oneof _cpu_overcommit_type.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

disks

Type

MutableSequence[google.cloud.compute_v1.types.LocalDisk]

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

node_affinity_labels

Labels to use for node affinity, which will be used in instance scheduling.

Type

MutableMapping[str, str]

node_type

The node type to use for nodes group that are created from this template.

This field is a member of oneof _node_type.

Type

str

node_type_flexibility

Do not use. Instead, use the node_type property.

This field is a member of oneof _node_type_flexibility.

Type

google.cloud.compute_v1.types.NodeTemplateNodeTypeFlexibility

region

[Output Only] The name of the region where the node template resides, such as us-central1.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

server_binding

Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information.

This field is a member of oneof _server_binding.

Type

google.cloud.compute_v1.types.ServerBinding

status

[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

status_message

[Output Only] An optional, human-readable explanation of the status.

This field is a member of oneof _status_message.

Type

str

class CpuOvercommitType(value)

Bases: proto.enums.Enum

CPU overcommit.

Values:

UNDEFINED_CPU_OVERCOMMIT_TYPE (0):

A value indicating that the enum field is not set.

CPU_OVERCOMMIT_TYPE_UNSPECIFIED (520665615):

No description available.

ENABLED (182130465):

No description available.

NONE (2402104):

No description available.

class NodeAffinityLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

Resources are being allocated.

DELETING (528602024):

The node template is currently being deleted.

INVALID (530283991):

Invalid status.

READY (77848963):

The node template is ready.

class google.cloud.compute_v1.types.NodeTemplateAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NodeTemplatesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.NodeTemplatesScopedList]

kind

[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.NodeTemplateList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of node templates.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NodeTemplate resources.

Type

MutableSequence[google.cloud.compute_v1.types.NodeTemplate]

kind

[Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NodeTemplateNodeTypeFlexibility(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

cpus

This field is a member of oneof _cpus.

Type

str

local_ssd

This field is a member of oneof _local_ssd.

Type

str

memory

This field is a member of oneof _memory.

Type

str

class google.cloud.compute_v1.types.NodeTemplatesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

node_templates

[Output Only] A list of node templates contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.NodeTemplate]

warning

[Output Only] An informational warning that appears when the node templates list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NodeType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types.

cpu_platform

[Output Only] The CPU platform used by this node type.

This field is a member of oneof _cpu_platform.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

deprecated

[Output Only] The deprecation status associated with this node type.

This field is a member of oneof _deprecated.

Type

google.cloud.compute_v1.types.DeprecationStatus

description

[Output Only] An optional textual description of the resource.

This field is a member of oneof _description.

Type

str

guest_cpus

[Output Only] The number of virtual CPUs that are available to the node type.

This field is a member of oneof _guest_cpus.

Type

int

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] The type of the resource. Always compute#nodeType for node types.

This field is a member of oneof _kind.

Type

str

local_ssd_gb

[Output Only] Local SSD available to the node type, defined in GB.

This field is a member of oneof _local_ssd_gb.

Type

int

memory_mb

[Output Only] The amount of physical memory available to the node type, defined in MB.

This field is a member of oneof _memory_mb.

Type

int

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

zone

[Output Only] The name of the zone where the node type resides, such as us-central1-a.

This field is a member of oneof _zone.

Type

str

class google.cloud.compute_v1.types.NodeTypeAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NodeTypesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.NodeTypesScopedList]

kind

[Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.NodeTypeList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of node types.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NodeType resources.

Type

MutableSequence[google.cloud.compute_v1.types.NodeType]

kind

[Output Only] Type of resource.Always compute#nodeTypeList for lists of node types.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NodeTypesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

node_types

[Output Only] A list of node types contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.NodeType]

warning

[Output Only] An informational warning that appears when the node types list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.NotificationEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a notification endpoint. A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. For more information, see Health checks overview.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

grpc_settings

Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.

This field is a member of oneof _grpc_settings.

Type

google.cloud.compute_v1.types.NotificationEndpointGrpcSettings

id

[Output Only] A unique identifier for this resource type. The server generates this identifier.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

region

[Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

class google.cloud.compute_v1.types.NotificationEndpointGrpcSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint.

authority

Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3

This field is a member of oneof _authority.

Type

str

endpoint

Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.

This field is a member of oneof _endpoint.

Type

str

payload_name

Optional. If specified, this field is used to populate the “name” field in gRPC requests.

This field is a member of oneof _payload_name.

Type

str

resend_interval

Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. Can only be set for regional notification endpoints.

This field is a member of oneof _resend_interval.

Type

google.cloud.compute_v1.types.Duration

retry_duration_sec

How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.

This field is a member of oneof _retry_duration_sec.

Type

int

class google.cloud.compute_v1.types.NotificationEndpointList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of NotificationEndpoint resources.

Type

MutableSequence[google.cloud.compute_v1.types.NotificationEndpoint]

kind

[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.Operation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an Operation resource. Google Compute Engine has three Operation resources: * Global * Regional * Zonal You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zoneOperations resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.

client_operation_id

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

This field is a member of oneof _client_operation_id.

Type

str

creation_timestamp

[Deprecated] This field is deprecated.

This field is a member of oneof _creation_timestamp.

Type

str

description

[Output Only] A textual description of the operation, which is set when the operation is created.

This field is a member of oneof _description.

Type

str

end_time

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

This field is a member of oneof _end_time.

Type

str

error

[Output Only] If errors are generated during processing of the operation, this field will be populated.

This field is a member of oneof _error.

Type

google.cloud.compute_v1.types.Error

http_error_message

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

This field is a member of oneof _http_error_message.

Type

str

http_error_status_code

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

This field is a member of oneof _http_error_status_code.

Type

int

id

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

insert_time

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

This field is a member of oneof _insert_time.

Type

str

instances_bulk_insert_operation_metadata

This field is a member of oneof _instances_bulk_insert_operation_metadata.

Type

google.cloud.compute_v1.types.InstancesBulkInsertOperationMetadata

kind

[Output Only] Type of the resource. Always compute#operation for Operation resources.

This field is a member of oneof _kind.

Type

str

name

[Output Only] Name of the operation.

This field is a member of oneof _name.

Type

str

operation_group_id

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

This field is a member of oneof _operation_group_id.

Type

str

operation_type

[Output Only] The type of operation, such as insert, update, or delete, and so on.

This field is a member of oneof _operation_type.

Type

str

progress

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

This field is a member of oneof _progress.

Type

int

region

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

set_common_instance_metadata_operation_metadata

[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.

This field is a member of oneof _set_common_instance_metadata_operation_metadata.

Type

google.cloud.compute_v1.types.SetCommonInstanceMetadataOperationMetadata

start_time

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

This field is a member of oneof _start_time.

Type

str

status

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

This field is a member of oneof _status.

Type

google.cloud.compute_v1.types.Operation.Status

status_message

[Output Only] An optional textual description of the current status of the operation.

This field is a member of oneof _status_message.

Type

str

target_id

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

This field is a member of oneof _target_id.

Type

int

target_link

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.

This field is a member of oneof _target_link.

Type

str

user

[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).

This field is a member of oneof _user.

Type

str

warnings

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

Type

MutableSequence[google.cloud.compute_v1.types.Warnings]

zone

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

This field is a member of oneof _zone.

Type

str

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

DONE (2104194):

No description available.

PENDING (35394935):

No description available.

RUNNING (121282975):

No description available.

class google.cloud.compute_v1.types.OperationAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

str

items

[Output Only] A map of scoped operation lists.

Type

MutableMapping[str, google.cloud.compute_v1.types.OperationsScopedList]

kind

[Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.OperationList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of Operation resources.

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

str

items

[Output Only] A list of Operation resources.

Type

MutableSequence[google.cloud.compute_v1.types.Operation]

kind

[Output Only] Type of resource. Always compute#operations for Operations resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.OperationsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

operations

[Output Only] A list of operations contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.Operation]

warning

[Output Only] Informational warning which replaces the list of operations when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.OutlierDetection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.

base_ejection_time

The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.

This field is a member of oneof _base_ejection_time.

Type

google.cloud.compute_v1.types.Duration

consecutive_errors

Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

This field is a member of oneof _consecutive_errors.

Type

int

consecutive_gateway_failure

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

This field is a member of oneof _consecutive_gateway_failure.

Type

int

enforcing_consecutive_errors

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

This field is a member of oneof _enforcing_consecutive_errors.

Type

int

enforcing_consecutive_gateway_failure

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

This field is a member of oneof _enforcing_consecutive_gateway_failure.

Type

int

enforcing_success_rate

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.

This field is a member of oneof _enforcing_success_rate.

Type

int

interval

Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.

This field is a member of oneof _interval.

Type

google.cloud.compute_v1.types.Duration

max_ejection_percent

Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.

This field is a member of oneof _max_ejection_percent.

Type

int

success_rate_minimum_hosts

The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.

This field is a member of oneof _success_rate_minimum_hosts.

Type

int

success_rate_request_volume

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.

This field is a member of oneof _success_rate_request_volume.

Type

int

success_rate_stdev_factor

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.

This field is a member of oneof _success_rate_stdev_factor.

Type

int

class google.cloud.compute_v1.types.PacketIntervals(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Next free: 7

avg_ms

Average observed inter-packet interval in milliseconds.

This field is a member of oneof _avg_ms.

Type

int

duration

From how long ago in the past these intervals were observed. Check the Duration enum for the list of possible values.

This field is a member of oneof _duration.

Type

str

max_ms

Maximum observed inter-packet interval in milliseconds.

This field is a member of oneof _max_ms.

Type

int

min_ms

Minimum observed inter-packet interval in milliseconds.

This field is a member of oneof _min_ms.

Type

int

num_intervals

Number of inter-packet intervals from which these statistics were derived.

This field is a member of oneof _num_intervals.

Type

int

type_

The type of packets for which inter-packet intervals were computed. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Duration(value)

Bases: proto.enums.Enum

From how long ago in the past these intervals were observed.

Values:

UNDEFINED_DURATION (0):

A value indicating that the enum field is not set.

DURATION_UNSPECIFIED (529071340):

No description available.

HOUR (2223588):

No description available.

MAX (76100):

From BfdSession object creation time.

MINUTE (126786068):

No description available.

class Type(value)

Bases: proto.enums.Enum

The type of packets for which inter-packet intervals were computed.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

LOOPBACK (356174219):

Only applies to Echo packets. This shows the intervals between sending and receiving the same packet.

RECEIVE (189660867):

Intervals between received packets.

TRANSMIT (452903600):

Intervals between transmitted packets.

TYPE_UNSPECIFIED (437714322):

No description available.

class google.cloud.compute_v1.types.PacketMirroring(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Packet Mirroring resource. Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring.

collector_ilb

The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.

This field is a member of oneof _collector_ilb.

Type

google.cloud.compute_v1.types.PacketMirroringForwardingRuleInfo

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

enable

Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. Check the Enable enum for the list of possible values.

This field is a member of oneof _enable.

Type

str

filter

Filter for mirrored traffic. If unspecified, all IPv4 traffic is mirrored.

This field is a member of oneof _filter.

Type

google.cloud.compute_v1.types.PacketMirroringFilter

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.

This field is a member of oneof _kind.

Type

str

mirrored_resources

PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.

This field is a member of oneof _mirrored_resources.

Type

google.cloud.compute_v1.types.PacketMirroringMirroredResourceInfo

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.

This field is a member of oneof _name.

Type

str

network

Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.

This field is a member of oneof _network.

Type

google.cloud.compute_v1.types.PacketMirroringNetworkInfo

priority

The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.

This field is a member of oneof _priority.

Type

int

region

[Output Only] URI of the region where the packetMirroring resides.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

class Enable(value)

Bases: proto.enums.Enum

Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE.

Values:

UNDEFINED_ENABLE (0):

A value indicating that the enum field is not set.

FALSE (66658563):

No description available.

TRUE (2583950):

No description available.

class google.cloud.compute_v1.types.PacketMirroringAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of packetMirrorings.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of PacketMirroring resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.PacketMirroringsScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.PacketMirroringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

I_p_protocols

Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all IPv4 traffic is mirrored.

Type

MutableSequence[str]

cidr_ranges

One or more IPv4 or IPv6 CIDR ranges that apply as filters on the source (ingress) or destination (egress) IP in the IP header. If no ranges are specified, all IPv4 traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all IPv4 traffic is mirrored. To mirror all IPv4 and IPv6 traffic, use “0.0.0.0/0,::/0”.

Type

MutableSequence[str]

direction

Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH. Check the Direction enum for the list of possible values.

This field is a member of oneof _direction.

Type

str

class Direction(value)

Bases: proto.enums.Enum

Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH.

Values:

UNDEFINED_DIRECTION (0):

A value indicating that the enum field is not set.

BOTH (2044801):

Default, both directions are mirrored.

EGRESS (432880501):

Only egress traffic is mirrored.

INGRESS (516931221):

Only ingress traffic is mirrored.

class google.cloud.compute_v1.types.PacketMirroringForwardingRuleInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

canonical_url

[Output Only] Unique identifier for the forwarding rule; defined by the server.

This field is a member of oneof _canonical_url.

Type

str

url

Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.

This field is a member of oneof _url.

Type

str

class google.cloud.compute_v1.types.PacketMirroringList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of PacketMirroring resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of PacketMirroring resources.

Type

MutableSequence[google.cloud.compute_v1.types.PacketMirroring]

kind

[Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.PacketMirroringMirroredResourceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring. Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring. You may specify a maximum of 50 Instances.

Type

MutableSequence[google.cloud.compute_v1.types.PacketMirroringMirroredResourceInfoInstanceInfo]

subnetworks

A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks.

Type

MutableSequence[google.cloud.compute_v1.types.PacketMirroringMirroredResourceInfoSubnetInfo]

tags

A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.PacketMirroringMirroredResourceInfoInstanceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

canonical_url

[Output Only] Unique identifier for the instance; defined by the server.

This field is a member of oneof _canonical_url.

Type

str

url

Resource URL to the virtual machine instance which is being mirrored.

This field is a member of oneof _url.

Type

str

class google.cloud.compute_v1.types.PacketMirroringMirroredResourceInfoSubnetInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

canonical_url

[Output Only] Unique identifier for the subnetwork; defined by the server.

This field is a member of oneof _canonical_url.

Type

str

url

Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.

This field is a member of oneof _url.

Type

str

class google.cloud.compute_v1.types.PacketMirroringNetworkInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

canonical_url

[Output Only] Unique identifier for the network; defined by the server.

This field is a member of oneof _canonical_url.

Type

str

url

URL of the network resource.

This field is a member of oneof _url.

Type

str

class google.cloud.compute_v1.types.PacketMirroringsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

packet_mirrorings

A list of packetMirrorings contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.PacketMirroring]

warning

Informational warning which replaces the list of packetMirrorings when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.PatchAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Autoscalers.Patch. See the method description for details.

autoscaler

Name of the autoscaler to patch.

This field is a member of oneof _autoscaler.

Type

str

autoscaler_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Autoscaler

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.PatchBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.Patch. See the method description for details.

backend_bucket

Name of the BackendBucket resource to patch.

Type

str

backend_bucket_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendBucket

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.Patch. See the method description for details.

backend_service

Name of the BackendService resource to patch.

Type

str

backend_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendService

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.Patch. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicy

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchFirewallRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Firewalls.Patch. See the method description for details.

firewall

Name of the firewall rule to patch.

Type

str

firewall_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Firewall

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ForwardingRules.Patch. See the method description for details.

forwarding_rule

Name of the ForwardingRule resource to patch.

Type

str

forwarding_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ForwardingRule

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchGlobalForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalForwardingRules.Patch. See the method description for details.

forwarding_rule

Name of the ForwardingRule resource to patch.

Type

str

forwarding_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ForwardingRule

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchGlobalPublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalPublicDelegatedPrefixes.Patch. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix

Name of the PublicDelegatedPrefix resource to patch.

Type

str

public_delegated_prefix_resource

The body resource for this request

Type

google.cloud.compute_v1.types.PublicDelegatedPrefix

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for HealthChecks.Patch. See the method description for details.

health_check

Name of the HealthCheck resource to patch.

Type

str

health_check_resource

The body resource for this request

Type

google.cloud.compute_v1.types.HealthCheck

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.Patch. See the method description for details.

image

Name of the image resource to patch.

Type

str

image_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Image

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.Patch. See the method description for details.

instance_group_manager

The name of the instance group manager.

Type

str

instance_group_manager_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManager

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where you want to create the managed instance group.

Type

str

class google.cloud.compute_v1.types.PatchInstanceSettingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceSettingsService.Patch. See the method description for details.

instance_settings_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceSettings

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

update_mask

update_mask indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

zone

The zone scoping this request. It should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.PatchInterconnectAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectAttachments.Patch. See the method description for details.

interconnect_attachment

Name of the interconnect attachment to patch.

Type

str

interconnect_attachment_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InterconnectAttachment

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchInterconnectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Interconnects.Patch. See the method description for details.

interconnect

Name of the interconnect to update.

Type

str

interconnect_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Interconnect

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchNetworkAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.Patch. See the method description for details.

network_attachment

Name of the NetworkAttachment resource to patch.

Type

str

network_attachment_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkAttachment

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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). end_interface: MixerMutationRequestBuilder

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchNetworkEdgeSecurityServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEdgeSecurityServices.Patch. See the method description for details.

network_edge_security_service

Name of the network edge security service to update.

Type

str

network_edge_security_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkEdgeSecurityService

paths

This field is a member of oneof _paths.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

update_mask

Indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

class google.cloud.compute_v1.types.PatchNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.Patch. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicy

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.Patch. See the method description for details.

network

Name of the network to update.

Type

str

network_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Network

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.Patch. See the method description for details.

node_group

Name of the NodeGroup resource to update.

Type

str

node_group_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NodeGroup

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.PatchPacketMirroringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PacketMirrorings.Patch. See the method description for details.

packet_mirroring

Name of the PacketMirroring resource to patch.

Type

str

packet_mirroring_resource

The body resource for this request

Type

google.cloud.compute_v1.types.PacketMirroring

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchPerInstanceConfigsInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.PatchPerInstanceConfigs. See the method description for details.

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

instance_group_managers_patch_per_instance_configs_req_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersPatchPerInstanceConfigsReq

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the managed instance group is located. It should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.PatchPerInstanceConfigsRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.PatchPerInstanceConfigs. See the method description for details.

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request, should conform to RFC1035.

Type

str

region_instance_group_manager_patch_instance_config_req_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagerPatchInstanceConfigReq

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchPublicAdvertisedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicAdvertisedPrefixes.Patch. See the method description for details.

project

Project ID for this request.

Type

str

public_advertised_prefix

Name of the PublicAdvertisedPrefix resource to patch.

Type

str

public_advertised_prefix_resource

The body resource for this request

Type

google.cloud.compute_v1.types.PublicAdvertisedPrefix

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchPublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicDelegatedPrefixes.Patch. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix

Name of the PublicDelegatedPrefix resource to patch.

Type

str

public_delegated_prefix_resource

The body resource for this request

Type

google.cloud.compute_v1.types.PublicDelegatedPrefix

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRegionAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionAutoscalers.Patch. See the method description for details.

autoscaler

Name of the autoscaler to patch.

This field is a member of oneof _autoscaler.

Type

str

autoscaler_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Autoscaler

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.Patch. See the method description for details.

backend_service

Name of the BackendService resource to patch.

Type

str

backend_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendService

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRegionHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthChecks.Patch. See the method description for details.

health_check

Name of the HealthCheck resource to patch.

Type

str

health_check_resource

The body resource for this request

Type

google.cloud.compute_v1.types.HealthCheck

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRegionHealthCheckServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthCheckServices.Patch. See the method description for details.

health_check_service

Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.

Type

str

health_check_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.HealthCheckService

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.Patch. See the method description for details.

instance_group_manager

The name of the instance group manager.

Type

str

instance_group_manager_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManager

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.Patch. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicy

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRegionSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy

Name of the security policy to update.

Type

str

security_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicy

update_mask

Indicates fields to be cleared as part of this request.

This field is a member of oneof _update_mask.

Type

str

class google.cloud.compute_v1.types.PatchRegionSslPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSslPolicies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

ssl_policy

Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.

Type

str

ssl_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SslPolicy

class google.cloud.compute_v1.types.PatchRegionTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpsProxies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxy

Name of the TargetHttpsProxy resource to patch.

Type

str

target_https_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpsProxy

class google.cloud.compute_v1.types.PatchRegionUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionUrlMaps.Patch. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

This field is a member of oneof _request_id.

Type

str

url_map

Name of the UrlMap resource to patch.

Type

str

url_map_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMap

class google.cloud.compute_v1.types.PatchResourcePolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource_policy

Id of the resource policy to patch.

Type

str

resource_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ResourcePolicy

update_mask

update_mask indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

class google.cloud.compute_v1.types.PatchRouterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.Patch. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

router

Name of the Router resource to patch.

Type

str

router_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Router

class google.cloud.compute_v1.types.PatchRuleFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.PatchRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyRule

priority

The priority of the rule to patch.

This field is a member of oneof _priority.

Type

int

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRuleNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.PatchRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyRule

priority

The priority of the rule to patch.

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRuleRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.PatchRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

firewall_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.FirewallPolicyRule

priority

The priority of the rule to patch.

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.PatchRuleRegionSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.PatchRule. See the method description for details.

priority

The priority of the rule to patch.

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

security_policy

Name of the security policy to update.

Type

str

security_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyRule

update_mask

Indicates fields to be cleared as part of this request.

This field is a member of oneof _update_mask.

Type

str

validate_only

If true, the request will not be committed.

This field is a member of oneof _validate_only.

Type

bool

class google.cloud.compute_v1.types.PatchRuleSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.PatchRule. See the method description for details.

priority

The priority of the rule to patch.

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

security_policy

Name of the security policy to update.

Type

str

security_policy_rule_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyRule

update_mask

Indicates fields to be cleared as part of this request.

This field is a member of oneof _update_mask.

Type

str

validate_only

If true, the request will not be committed.

This field is a member of oneof _validate_only.

Type

bool

class google.cloud.compute_v1.types.PatchSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy

Name of the security policy to update.

Type

str

security_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicy

update_mask

Indicates fields to be cleared as part of this request.

This field is a member of oneof _update_mask.

Type

str

class google.cloud.compute_v1.types.PatchServiceAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.Patch. See the method description for details.

project

Project ID for this request.

Type

str

region

The region scoping this request and should conform to RFC1035.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

service_attachment

The resource id of the ServiceAttachment to patch. It should conform to RFC1035 resource name or be a string form on an unsigned long number.

Type

str

service_attachment_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ServiceAttachment

class google.cloud.compute_v1.types.PatchSnapshotSettingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SnapshotSettingsService.Patch. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

snapshot_settings_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SnapshotSettings

update_mask

update_mask indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

class google.cloud.compute_v1.types.PatchSslPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SslPolicies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

ssl_policy

Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.

Type

str

ssl_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SslPolicy

class google.cloud.compute_v1.types.PatchSubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.Patch. See the method description for details.

drain_timeout_seconds

The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.

This field is a member of oneof _drain_timeout_seconds.

Type

int

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

subnetwork

Name of the Subnetwork resource to patch.

Type

str

subnetwork_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Subnetwork

class google.cloud.compute_v1.types.PatchTargetGrpcProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetGrpcProxies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_grpc_proxy

Name of the TargetGrpcProxy resource to patch.

Type

str

target_grpc_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetGrpcProxy

class google.cloud.compute_v1.types.PatchTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpProxies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_http_proxy

Name of the TargetHttpProxy resource to patch.

Type

str

target_http_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpProxy

class google.cloud.compute_v1.types.PatchTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.Patch. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxy

Name of the TargetHttpsProxy resource to patch.

Type

str

target_https_proxy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpsProxy

class google.cloud.compute_v1.types.PatchUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.Patch. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

url_map

Name of the UrlMap resource to patch.

Type

str

url_map_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMap

class google.cloud.compute_v1.types.PathMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.

default_custom_error_response_policy

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher’s policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

This field is a member of oneof _default_custom_error_response_policy.

Type

google.cloud.compute_v1.types.CustomErrorResponsePolicy

default_route_action

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don’t set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don’t set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher’s defaultRouteAction.

This field is a member of oneof _default_route_action.

Type

google.cloud.compute_v1.types.HttpRouteAction

default_service

The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don’t set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

This field is a member of oneof _default_service.

Type

str

default_url_redirect

When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don’t set both. Not supported when the URL map is bound to a target gRPC proxy.

This field is a member of oneof _default_url_redirect.

Type

google.cloud.compute_v1.types.HttpRedirectAction

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

header_action

Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

This field is a member of oneof _header_action.

Type

google.cloud.compute_v1.types.HttpHeaderAction

name

The name to which this PathMatcher is referred by the HostRule.

This field is a member of oneof _name.

Type

str

path_rules

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that’s required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.

Type

MutableSequence[google.cloud.compute_v1.types.PathRule]

route_rules

The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.

Type

MutableSequence[google.cloud.compute_v1.types.HttpRouteRule]

class google.cloud.compute_v1.types.PathRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

custom_error_response_policy

customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher’s policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers.

This field is a member of oneof _custom_error_response_policy.

Type

google.cloud.compute_v1.types.CustomErrorResponsePolicy

paths

The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

Type

MutableSequence[str]

route_action

In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule’s routeAction.

This field is a member of oneof _route_action.

Type

google.cloud.compute_v1.types.HttpRouteAction

service

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

This field is a member of oneof _service.

Type

str

url_redirect

When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

This field is a member of oneof _url_redirect.

Type

google.cloud.compute_v1.types.HttpRedirectAction

class google.cloud.compute_v1.types.PerInstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

fingerprint

Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.

This field is a member of oneof _fingerprint.

Type

str

name

The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configconfiguration for a VM instance that either doesn’t exist or is not part of the group will result in an error.

This field is a member of oneof _name.

Type

str

preserved_state

The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.

This field is a member of oneof _preserved_state.

Type

google.cloud.compute_v1.types.PreservedState

status

The status of applying this per-instance configuration on the corresponding managed instance. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class Status(value)

Bases: proto.enums.Enum

The status of applying this per-instance configuration on the corresponding managed instance.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

APPLYING (352003508):

The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.

DELETING (528602024):

The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.

EFFECTIVE (244201863):

The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.

NONE (2402104):

[Default] The default status, when no per-instance configuration exists.

UNAPPLIED (483935140):

The per-instance configuration is set on an instance but not been applied yet.

UNAPPLIED_DELETION (313956873):

The per-instance configuration has been deleted, but the deletion is not yet applied.

class google.cloud.compute_v1.types.PerformMaintenanceInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.PerformMaintenance. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.PerformMaintenanceNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.PerformMaintenance. See the method description for details.

node_group

Name of the node group scoping this request.

Type

str

node_groups_perform_maintenance_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NodeGroupsPerformMaintenanceRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.Policy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.

audit_configs

Specifies cloud audit logging configuration for this policy.

Type

MutableSequence[google.cloud.compute_v1.types.AuditConfig]

bindings

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

Type

MutableSequence[google.cloud.compute_v1.types.Binding]

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. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

This field is a member of oneof _etag.

Type

str

iam_owned

This field is a member of oneof _iam_owned.

Type

bool

version

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

This field is a member of oneof _version.

Type

int

class google.cloud.compute_v1.types.PreconfiguredWafSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

expression_sets

List of entities that are currently supported for WAF rules.

Type

MutableSequence[google.cloud.compute_v1.types.WafExpressionSet]

class google.cloud.compute_v1.types.PreservedState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Preserved state for a given instance.

disks

Preserved disks defined for this instance. This map is keyed with the device names of the disks.

Type

MutableMapping[str, google.cloud.compute_v1.types.PreservedStatePreservedDisk]

external_i_ps

Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.

Type

MutableMapping[str, google.cloud.compute_v1.types.PreservedStatePreservedNetworkIp]

internal_i_ps

Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.

Type

MutableMapping[str, google.cloud.compute_v1.types.PreservedStatePreservedNetworkIp]

metadata

Preserved metadata defined for this instance.

Type

MutableMapping[str, str]

class DisksEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class ExternalIPsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class InternalIPsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.PreservedStatePreservedDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

auto_delete

These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. Check the AutoDelete enum for the list of possible values.

This field is a member of oneof _auto_delete.

Type

str

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. Check the Mode enum for the list of possible values.

This field is a member of oneof _mode.

Type

str

source

The URL of the disk resource that is stateful and should be attached to the VM instance.

This field is a member of oneof _source.

Type

str

class AutoDelete(value)

Bases: proto.enums.Enum

These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.

Values:

UNDEFINED_AUTO_DELETE (0):

A value indicating that the enum field is not set.

NEVER (74175084):

No description available.

ON_PERMANENT_INSTANCE_DELETION (95727719):

No description available.

class Mode(value)

Bases: proto.enums.Enum

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

Values:

UNDEFINED_MODE (0):

A value indicating that the enum field is not set.

READ_ONLY (91950261):

Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.

READ_WRITE (173607894):

[Default] Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode.

class google.cloud.compute_v1.types.PreservedStatePreservedNetworkIp(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

auto_delete

These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Check the AutoDelete enum for the list of possible values.

This field is a member of oneof _auto_delete.

Type

str

ip_address

Ip address representation

This field is a member of oneof _ip_address.

Type

google.cloud.compute_v1.types.PreservedStatePreservedNetworkIpIpAddress

class AutoDelete(value)

Bases: proto.enums.Enum

These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

Values:

UNDEFINED_AUTO_DELETE (0):

A value indicating that the enum field is not set.

NEVER (74175084):

No description available.

ON_PERMANENT_INSTANCE_DELETION (95727719):

No description available.

class google.cloud.compute_v1.types.PreservedStatePreservedNetworkIpIpAddress(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

address

The URL of the reservation for this IP address.

This field is a member of oneof _address.

Type

str

literal

An IPv4 internal network address to assign to the instance for this network interface.

This field is a member of oneof _literal.

Type

str

class google.cloud.compute_v1.types.PreviewRouterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.Preview. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

router

Name of the Router resource to query.

Type

str

router_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Router

class google.cloud.compute_v1.types.Project(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.

cloud_armor_tier

[Output Only] The Cloud Armor tier for this project. It can be one of the following values: CA_STANDARD, CA_ENTERPRISE_PAYGO. If this field is not specified, it is assumed to be CA_STANDARD. Check the CloudArmorTier enum for the list of possible values.

This field is a member of oneof _cloud_armor_tier.

Type

str

common_instance_metadata

Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.

This field is a member of oneof _common_instance_metadata.

Type

google.cloud.compute_v1.types.Metadata

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

default_network_tier

This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. Check the DefaultNetworkTier enum for the list of possible values.

This field is a member of oneof _default_network_tier.

Type

str

default_service_account

[Output Only] Default service account used by VMs running in this project.

This field is a member of oneof _default_service_account.

Type

str

description

An optional textual description of the resource.

This field is a member of oneof _description.

Type

str

enabled_features

Restricted features enabled for use on this project.

Type

MutableSequence[str]

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#project for projects.

This field is a member of oneof _kind.

Type

str

name

The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.

This field is a member of oneof _name.

Type

str

quotas

[Output Only] Quotas assigned to this project.

Type

MutableSequence[google.cloud.compute_v1.types.Quota]

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

usage_export_location

The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.

This field is a member of oneof _usage_export_location.

Type

google.cloud.compute_v1.types.UsageExportLocation

vm_dns_setting

[Output Only] Default internal DNS setting used by VMs running in this project. Check the VmDnsSetting enum for the list of possible values.

This field is a member of oneof _vm_dns_setting.

Type

str

xpn_project_status

[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. Check the XpnProjectStatus enum for the list of possible values.

This field is a member of oneof _xpn_project_status.

Type

str

class CloudArmorTier(value)

Bases: proto.enums.Enum

[Output Only] The Cloud Armor tier for this project. It can be one of the following values: CA_STANDARD, CA_ENTERPRISE_PAYGO. If this field is not specified, it is assumed to be CA_STANDARD.

Values:

UNDEFINED_CLOUD_ARMOR_TIER (0):

A value indicating that the enum field is not set.

CA_ENTERPRISE_ANNUAL (219921116):

Enterprise tier protection billed annually.

CA_ENTERPRISE_PAYGO (453530323):

Enterprise tier protection billed monthly.

CA_STANDARD (13156734):

Standard protection.

class DefaultNetworkTier(value)

Bases: proto.enums.Enum

This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.

Values:

UNDEFINED_DEFAULT_NETWORK_TIER (0):

A value indicating that the enum field is not set.

FIXED_STANDARD (310464328):

Public internet quality with fixed bandwidth.

PREMIUM (399530551):

High quality, Google-grade network tier, support for all networking products.

STANDARD (484642493):

Public internet quality, only limited support for other networking products.

STANDARD_OVERRIDES_FIXED_STANDARD (465847234):

(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

class VmDnsSetting(value)

Bases: proto.enums.Enum

[Output Only] Default internal DNS setting used by VMs running in this project.

Values:

UNDEFINED_VM_DNS_SETTING (0):

A value indicating that the enum field is not set.

GLOBAL_DEFAULT (345419141):

No description available.

UNSPECIFIED_VM_DNS_SETTING (35691930):

No description available.

ZONAL_DEFAULT (368475782):

No description available.

ZONAL_ONLY (521198951):

No description available.

class XpnProjectStatus(value)

Bases: proto.enums.Enum

[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.

Values:

UNDEFINED_XPN_PROJECT_STATUS (0):

A value indicating that the enum field is not set.

HOST (2223528):

No description available.

UNSPECIFIED_XPN_PROJECT_STATUS (340393257):

No description available.

class google.cloud.compute_v1.types.ProjectsDisableXpnResourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

xpn_resource

Service resource (a.k.a service project) ID.

This field is a member of oneof _xpn_resource.

Type

google.cloud.compute_v1.types.XpnResourceId

class google.cloud.compute_v1.types.ProjectsEnableXpnResourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

xpn_resource

Service resource (a.k.a service project) ID.

This field is a member of oneof _xpn_resource.

Type

google.cloud.compute_v1.types.XpnResourceId

class google.cloud.compute_v1.types.ProjectsGetXpnResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

kind

[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects)

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

resources

Service resources (a.k.a service projects) attached to this project as their shared VPC host.

Type

MutableSequence[google.cloud.compute_v1.types.XpnResourceId]

class google.cloud.compute_v1.types.ProjectsListXpnHostsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This field is a member of oneof _organization.

Type

str

class google.cloud.compute_v1.types.ProjectsSetCloudArmorTierRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

cloud_armor_tier

Managed protection tier to be set. Check the CloudArmorTier enum for the list of possible values.

This field is a member of oneof _cloud_armor_tier.

Type

str

class CloudArmorTier(value)

Bases: proto.enums.Enum

Managed protection tier to be set.

Values:

UNDEFINED_CLOUD_ARMOR_TIER (0):

A value indicating that the enum field is not set.

CA_ENTERPRISE_ANNUAL (219921116):

Enterprise tier protection billed annually.

CA_ENTERPRISE_PAYGO (453530323):

Enterprise tier protection billed monthly.

CA_STANDARD (13156734):

Standard protection.

class google.cloud.compute_v1.types.ProjectsSetDefaultNetworkTierRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_tier

Default network tier to be set. Check the NetworkTier enum for the list of possible values.

This field is a member of oneof _network_tier.

Type

str

class NetworkTier(value)

Bases: proto.enums.Enum

Default network tier to be set.

Values:

UNDEFINED_NETWORK_TIER (0):

A value indicating that the enum field is not set.

FIXED_STANDARD (310464328):

Public internet quality with fixed bandwidth.

PREMIUM (399530551):

High quality, Google-grade network tier, support for all networking products.

STANDARD (484642493):

Public internet quality, only limited support for other networking products.

STANDARD_OVERRIDES_FIXED_STANDARD (465847234):

(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

class google.cloud.compute_v1.types.PublicAdvertisedPrefix(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.

byoip_api_version

[Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

This field is a member of oneof _byoip_api_version.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

dns_verification_ip

The address to be used for reverse DNS verification.

This field is a member of oneof _dns_verification_ip.

Type

str

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 new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource type. The server generates this identifier.

This field is a member of oneof _id.

Type

int

ip_cidr_range

The address range, in CIDR format, represented by this public advertised prefix.

This field is a member of oneof _ip_cidr_range.

Type

str

kind

[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

pdp_scope

Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL [output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2. Check the PdpScope enum for the list of possible values.

This field is a member of oneof _pdp_scope.

Type

str

public_delegated_prefixs

[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

Type

MutableSequence[google.cloud.compute_v1.types.PublicAdvertisedPrefixPublicDelegatedPrefix]

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

shared_secret

[Output Only] The shared secret to be used for reverse DNS verification.

This field is a member of oneof _shared_secret.

Type

str

status

The status of the public advertised prefix. Possible values include: - INITIAL: RPKI validation is complete. - PTR_CONFIGURED: User has configured the PTR. - VALIDATED: Reverse DNS lookup is successful. - REVERSE_DNS_LOOKUP_FAILED: Reverse DNS lookup failed. - PREFIX_CONFIGURATION_IN_PROGRESS: The prefix is being configured. - PREFIX_CONFIGURATION_COMPLETE: The prefix is fully configured. - PREFIX_REMOVAL_IN_PROGRESS: The prefix is being removed. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class ByoipApiVersion(value)

Bases: proto.enums.Enum

[Output Only] The version of BYOIP API.

Values:

UNDEFINED_BYOIP_API_VERSION (0):

A value indicating that the enum field is not set.

V1 (2715):

This public advertised prefix can be used to create both regional and global public delegated prefixes. It usually takes 4 weeks to create or delete a public delegated prefix. The BGP status cannot be changed.

V2 (2716):

This public advertised prefix can only be used to create regional public delegated prefixes. Public delegated prefix creation and deletion takes minutes and the BGP status can be modified.

class PdpScope(value)

Bases: proto.enums.Enum

Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL [output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2.

Values:

UNDEFINED_PDP_SCOPE (0):

A value indicating that the enum field is not set.

GLOBAL (494663587):

The public delegated prefix is global only. The provisioning will take ~4 weeks.

GLOBAL_AND_REGIONAL (318053059):

The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2.

REGIONAL (92288543):

The public delegated prefix is regional only. The provisioning will take a few minutes.

class Status(value)

Bases: proto.enums.Enum

The status of the public advertised prefix. Possible values include: - INITIAL: RPKI validation is complete. - PTR_CONFIGURED: User has configured the PTR. - VALIDATED: Reverse DNS lookup is successful. - REVERSE_DNS_LOOKUP_FAILED: Reverse DNS lookup failed. - PREFIX_CONFIGURATION_IN_PROGRESS: The prefix is being configured. - PREFIX_CONFIGURATION_COMPLETE: The prefix is fully configured. - PREFIX_REMOVAL_IN_PROGRESS: The prefix is being removed.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ANNOUNCED_TO_INTERNET (177880897):

The prefix is announced to Internet.

INITIAL (518841124):

RPKI validation is complete.

PREFIX_CONFIGURATION_COMPLETE (480889551):

The prefix is fully configured.

PREFIX_CONFIGURATION_IN_PROGRESS (378550961):

The prefix is being configured.

PREFIX_REMOVAL_IN_PROGRESS (284375783):

The prefix is being removed.

PTR_CONFIGURED (513497167):

User has configured the PTR.

READY_TO_ANNOUNCE (64641265):

The prefix is currently withdrawn but ready to be announced.

REVERSE_DNS_LOOKUP_FAILED (295755183):

Reverse DNS lookup failed.

VALIDATED (66197998):

Reverse DNS lookup is successful.

class google.cloud.compute_v1.types.PublicAdvertisedPrefixList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of PublicAdvertisedPrefix resources.

Type

MutableSequence[google.cloud.compute_v1.types.PublicAdvertisedPrefix]

kind

[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.PublicAdvertisedPrefixPublicDelegatedPrefix(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a CIDR range which can be used to assign addresses.

ip_range

The IP address range of the public delegated prefix

This field is a member of oneof _ip_range.

Type

str

name

The name of the public delegated prefix

This field is a member of oneof _name.

Type

str

project

The project number of the public delegated prefix

This field is a member of oneof _project.

Type

str

region

The region of the public delegated prefix if it is regional. If absent, the prefix is global.

This field is a member of oneof _region.

Type

str

status

The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.

This field is a member of oneof _status.

Type

str

class google.cloud.compute_v1.types.PublicDelegatedPrefix(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.

allocatable_prefix_length

The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.

This field is a member of oneof _allocatable_prefix_length.

Type

int

byoip_api_version

[Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

This field is a member of oneof _byoip_api_version.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

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 new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource type. The server generates this identifier.

This field is a member of oneof _id.

Type

int

ip_cidr_range

The IP address range, in CIDR format, represented by this public delegated prefix.

This field is a member of oneof _ip_cidr_range.

Type

str

is_live_migration

If true, the prefix will be live migrated.

This field is a member of oneof _is_live_migration.

Type

bool

kind

[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

This field is a member of oneof _kind.

Type

str

mode

The public delegated prefix mode for IPv6 only. Check the Mode enum for the list of possible values.

This field is a member of oneof _mode.

Type

str

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.

This field is a member of oneof _name.

Type

str

parent_prefix

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

This field is a member of oneof _parent_prefix.

Type

str

public_delegated_sub_prefixs

The list of sub public delegated prefixes that exist for this public delegated prefix.

Type

MutableSequence[google.cloud.compute_v1.types.PublicDelegatedPrefixPublicDelegatedSubPrefix]

region

[Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

status

[Output Only] The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class ByoipApiVersion(value)

Bases: proto.enums.Enum

[Output Only] The version of BYOIP API.

Values:

UNDEFINED_BYOIP_API_VERSION (0):

A value indicating that the enum field is not set.

V1 (2715):

This public delegated prefix usually takes 4 weeks to delete, and the BGP status cannot be changed. Announce and Withdraw APIs can not be used on this prefix.

V2 (2716):

This public delegated prefix takes minutes to delete. Announce and Withdraw APIs can be used on this prefix to change the BGP status.

class Mode(value)

Bases: proto.enums.Enum

The public delegated prefix mode for IPv6 only.

Values:

UNDEFINED_MODE (0):

A value indicating that the enum field is not set.

DELEGATION (264149288):

The public delegated prefix is used for further sub-delegation only. Such prefixes cannot set allocatablePrefixLength.

EXTERNAL_IPV6_FORWARDING_RULE_CREATION (398684356):

The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes.

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ANNOUNCED (365103355):

The public delegated prefix is active.

ANNOUNCED_TO_GOOGLE (454875705):

The prefix is announced within Google network.

ANNOUNCED_TO_INTERNET (177880897):

The prefix is announced to Internet and within Google.

DELETING (528602024):

The public delegated prefix is being deprovsioned.

INITIALIZING (306588749):

The public delegated prefix is being initialized and addresses cannot be created yet.

READY_TO_ANNOUNCE (64641265):

The public delegated prefix is currently withdrawn but ready to be announced.

class google.cloud.compute_v1.types.PublicDelegatedPrefixAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of PublicDelegatedPrefixesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.PublicDelegatedPrefixesScopedList]

kind

[Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList for aggregated lists of public delegated prefixes.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.PublicDelegatedPrefixList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of PublicDelegatedPrefix resources.

Type

MutableSequence[google.cloud.compute_v1.types.PublicDelegatedPrefix]

kind

[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.PublicDelegatedPrefixPublicDelegatedSubPrefix(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a sub PublicDelegatedPrefix.

allocatable_prefix_length

The allocatable prefix length supported by this PublicDelegatedSubPrefix.

This field is a member of oneof _allocatable_prefix_length.

Type

int

delegatee_project

Name of the project scoping this PublicDelegatedSubPrefix.

This field is a member of oneof _delegatee_project.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

ip_cidr_range

The IP address range, in CIDR format, represented by this sub public delegated prefix.

This field is a member of oneof _ip_cidr_range.

Type

str

is_address

Whether the sub prefix is delegated to create Address resources in the delegatee project.

This field is a member of oneof _is_address.

Type

bool

mode

The PublicDelegatedSubPrefix mode for IPv6 only. Check the Mode enum for the list of possible values.

This field is a member of oneof _mode.

Type

str

name

The name of the sub public delegated prefix.

This field is a member of oneof _name.

Type

str

region

[Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.

This field is a member of oneof _region.

Type

str

status

[Output Only] The status of the sub public delegated prefix. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class Mode(value)

Bases: proto.enums.Enum

The PublicDelegatedSubPrefix mode for IPv6 only.

Values:

UNDEFINED_MODE (0):

A value indicating that the enum field is not set.

DELEGATION (264149288):

The public delegated prefix is used for further sub-delegation only. Such prefixes cannot set allocatablePrefixLength.

EXTERNAL_IPV6_FORWARDING_RULE_CREATION (398684356):

The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes.

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the sub public delegated prefix.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

No description available.

INACTIVE (270421099):

No description available.

class google.cloud.compute_v1.types.PublicDelegatedPrefixesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

public_delegated_prefixes

[Output Only] A list of PublicDelegatedPrefixes contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.PublicDelegatedPrefix]

warning

[Output Only] Informational warning which replaces the list of public delegated prefixes when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.Quota(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A quotas entry.

limit

[Output Only] Quota limit for this metric.

This field is a member of oneof _limit.

Type

float

metric

[Output Only] Name of the quota metric. Check the Metric enum for the list of possible values.

This field is a member of oneof _metric.

Type

str

owner

[Output Only] Owning resource. This is the resource on which this quota is applied.

This field is a member of oneof _owner.

Type

str

usage

[Output Only] Current usage of this metric.

This field is a member of oneof _usage.

Type

float

class Metric(value)

Bases: proto.enums.Enum

[Output Only] Name of the quota metric.

Values:

UNDEFINED_METRIC (0):

A value indicating that the enum field is not set.

A2_CPUS (153206585):

No description available.

AFFINITY_GROUPS (108303563):

No description available.

AUTOSCALERS (471248988):

No description available.

BACKEND_BUCKETS (137626846):

No description available.

BACKEND_SERVICES (269623753):

No description available.

C2D_CPUS (508182517):

No description available.

C2_CPUS (317601211):

No description available.

C3_CPUS (346230362):

No description available.

COMMITMENTS (456141790):

No description available.

COMMITTED_A2_CPUS (59330902):

No description available.

COMMITTED_C2D_CPUS (282390904):

No description available.

COMMITTED_C2_CPUS (223725528):

No description available.

COMMITTED_C3_CPUS (252354679):

No description available.

COMMITTED_CPUS (292394702):

No description available.

COMMITTED_E2_CPUS (388120154):

No description available.

COMMITTED_LICENSES (357606869):

No description available.

COMMITTED_LOCAL_SSD_TOTAL_GB (308393480):

No description available.

COMMITTED_M3_CPUS (585985):

No description available.

COMMITTED_MEMORY_OPTIMIZED_CPUS (489057886):

No description available.

COMMITTED_N2A_CPUS (40064304):

No description available.

COMMITTED_N2D_CPUS (125951757):

No description available.

COMMITTED_N2_CPUS (322589603):

No description available.

COMMITTED_NVIDIA_A100_80GB_GPUS (464326565):

No description available.

COMMITTED_NVIDIA_A100_GPUS (375799445):

No description available.

COMMITTED_NVIDIA_H100_GPUS (71649180):

No description available.

COMMITTED_NVIDIA_K80_GPUS (3857188):

No description available.

COMMITTED_NVIDIA_L4_GPUS (19163645):

No description available.

COMMITTED_NVIDIA_P100_GPUS (107528100):

No description available.

COMMITTED_NVIDIA_P4_GPUS (347952897):

No description available.

COMMITTED_NVIDIA_T4_GPUS (139871237):

No description available.

COMMITTED_NVIDIA_V100_GPUS (219562):

No description available.

COMMITTED_T2A_CPUS (296378986):

No description available.

COMMITTED_T2D_CPUS (382266439):

No description available.

COMMITTED_Z3_CPUS (263844686):

No description available.

CPUS (2075595):

Guest CPUs

CPUS_ALL_REGIONS (470911149):

No description available.

DISKS_TOTAL_GB (353520543):

No description available.

E2_CPUS (481995837):

No description available.

EXTERNAL_MANAGED_FORWARDING_RULES (150790089):

No description available.

EXTERNAL_NETWORK_LB_FORWARDING_RULES (374298265):

No description available.

EXTERNAL_PROTOCOL_FORWARDING_RULES (63478888):

No description available.

EXTERNAL_VPN_GATEWAYS (272457134):

No description available.

FIREWALLS (374485843):

No description available.

FORWARDING_RULES (432668949):

No description available.

GLOBAL_EXTERNAL_MANAGED_BACKEND_SERVICES (164566753):

No description available.

GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES (327611949):

No description available.

GLOBAL_EXTERNAL_PROXY_LB_BACKEND_SERVICES (400256169):

No description available.

GLOBAL_INTERNAL_ADDRESSES (42738332):

No description available.

GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES (256608303):

No description available.

GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES (323514196):

No description available.

GPUS_ALL_REGIONS (39387177):

No description available.

HDB_TOTAL_GB (319316271):

No description available.

HDB_TOTAL_IOPS (309720317):

No description available.

HDB_TOTAL_THROUGHPUT (20981374):

No description available.

HEALTH_CHECKS (289347502):

No description available.

IMAGES (15562360):

No description available.

INSTANCES (131337822):

No description available.

INSTANCE_GROUPS (355919038):

No description available.

INSTANCE_GROUP_MANAGERS (101798192):

No description available.

INSTANCE_TEMPLATES (226188271):

No description available.

INTERCONNECTS (415204741):

No description available.

INTERCONNECT_ATTACHMENTS_PER_REGION (159968086):

No description available.

INTERCONNECT_ATTACHMENTS_TOTAL_MBPS (425090419):

No description available.

INTERCONNECT_TOTAL_GBPS (285341866):

No description available.

INTERNAL_ADDRESSES (197899392):

No description available.

INTERNAL_TRAFFIC_DIRECTOR_FORWARDING_RULES (266433668):

No description available.

IN_PLACE_SNAPSHOTS (151359133):

No description available.

IN_USE_ADDRESSES (402125072):

No description available.

IN_USE_BACKUP_SCHEDULES (32786705):

No description available.

IN_USE_SNAPSHOT_SCHEDULES (462104083):

No description available.

LOCAL_SSD_TOTAL_GB (330878021):

No description available.

M1_CPUS (37203366):

No description available.

M2_CPUS (65832517):

No description available.

M3_CPUS (94461668):

No description available.

MACHINE_IMAGES (446986640):

No description available.

N2A_CPUS (265855917):

No description available.

N2D_CPUS (351743370):

No description available.

N2_CPUS (416465286):

No description available.

NETWORKS (485481477):

No description available.

NETWORK_ATTACHMENTS (149028575):

No description available.

NETWORK_ENDPOINT_GROUPS (102144909):

No description available.

NETWORK_FIREWALL_POLICIES (101117374):

No description available.

NET_LB_SECURITY_POLICIES_PER_REGION (157892269):

No description available.

NET_LB_SECURITY_POLICY_RULES_PER_REGION (356090931):

No description available.

NET_LB_SECURITY_POLICY_RULE_ATTRIBUTES_PER_REGION (311243888):

No description available.

NODE_GROUPS (24624817):

No description available.

NODE_TEMPLATES (474896668):

No description available.

NVIDIA_A100_80GB_GPUS (286389320):

No description available.

NVIDIA_A100_GPUS (504872978):

No description available.

NVIDIA_K80_GPUS (163886599):

No description available.

NVIDIA_L4_GPUS (491923130):

No description available.

NVIDIA_P100_GPUS (236601633):

No description available.

NVIDIA_P100_VWS_GPUS (213970574):

No description available.

NVIDIA_P4_GPUS (283841470):

No description available.

NVIDIA_P4_VWS_GPUS (528296619):

No description available.

NVIDIA_T4_GPUS (75759810):

No description available.

NVIDIA_T4_VWS_GPUS (319813039):

No description available.

NVIDIA_V100_GPUS (129293095):

No description available.

PACKET_MIRRORINGS (15578407):

No description available.

PD_EXTREME_TOTAL_PROVISIONED_IOPS (69593965):

No description available.

PREEMPTIBLE_CPUS (251184841):

No description available.

PREEMPTIBLE_LOCAL_SSD_GB (260819336):

No description available.

PREEMPTIBLE_NVIDIA_A100_80GB_GPUS (151942410):

No description available.

PREEMPTIBLE_NVIDIA_A100_GPUS (68832784):

No description available.

PREEMPTIBLE_NVIDIA_H100_GPUS (301553431):

No description available.

PREEMPTIBLE_NVIDIA_K80_GPUS (374960201):

No description available.

PREEMPTIBLE_NVIDIA_L4_GPUS (100408376):

No description available.

PREEMPTIBLE_NVIDIA_P100_GPUS (337432351):

No description available.

PREEMPTIBLE_NVIDIA_P100_VWS_GPUS (313544076):

No description available.

PREEMPTIBLE_NVIDIA_P4_GPUS (429197628):

No description available.

PREEMPTIBLE_NVIDIA_P4_VWS_GPUS (252981545):

No description available.

PREEMPTIBLE_NVIDIA_T4_GPUS (221115968):

No description available.

PREEMPTIBLE_NVIDIA_T4_VWS_GPUS (44497965):

No description available.

PREEMPTIBLE_NVIDIA_V100_GPUS (230123813):

No description available.

PREEMPTIBLE_TPU_LITE_DEVICE_V5 (174262523):

No description available.

PREEMPTIBLE_TPU_LITE_PODSLICE_V5 (112281796):

No description available.

PREEMPTIBLE_TPU_PODSLICE_V4 (425541132):

No description available.

PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK (231164291):

No description available.

PSC_INTERNAL_LB_FORWARDING_RULES (169005435):

No description available.

PUBLIC_ADVERTISED_PREFIXES (471371980):

No description available.

PUBLIC_DELEGATED_PREFIXES (532465974):

No description available.

REGIONAL_AUTOSCALERS (29363772):

No description available.

REGIONAL_EXTERNAL_MANAGED_BACKEND_SERVICES (4240989):

No description available.

REGIONAL_EXTERNAL_NETWORK_LB_BACKEND_SERVICES (409564525):

No description available.

REGIONAL_INSTANCE_GROUP_MANAGERS (37543696):

No description available.

REGIONAL_INTERNAL_LB_BACKEND_SERVICES (137983760):

No description available.

REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES (96282539):

No description available.

REGIONAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES (483162968):

No description available.

RESERVATIONS (32644647):

No description available.

RESOURCE_POLICIES (83955297):

No description available.

ROUTERS (493018666):

No description available.

ROUTES (275680074):

No description available.

SECURITY_POLICIES (189518703):

No description available.

SECURITY_POLICIES_PER_REGION (249041734):

No description available.

SECURITY_POLICY_ADVANCED_RULES_PER_REGION (371815341):

No description available.

SECURITY_POLICY_CEVAL_RULES (470815689):

No description available.

SECURITY_POLICY_RULES (203549225):

No description available.

SECURITY_POLICY_RULES_PER_REGION (126510156):

No description available.

SERVICE_ATTACHMENTS (471521510):

No description available.

SNAPSHOTS (343405327):

The total number of snapshots allowed for a single project.

SSD_TOTAL_GB (161732561):

No description available.

SSL_CERTIFICATES (378372399):

No description available.

SSL_POLICIES (523254339):

No description available.

STATIC_ADDRESSES (93624049):

No description available.

STATIC_BYOIP_ADDRESSES (275809649):

No description available.

STATIC_EXTERNAL_IPV6_ADDRESS_RANGES (472346774):

No description available.

SUBNETWORKS (421330469):

No description available.

T2A_CPUS (522170599):

No description available.

T2D_CPUS (71187140):

No description available.

TARGET_HTTPS_PROXIES (219522506):

No description available.

TARGET_HTTP_PROXIES (164117155):

No description available.

TARGET_INSTANCES (284519728):

No description available.

TARGET_POOLS (348261257):

No description available.

TARGET_SSL_PROXIES (159216235):

No description available.

TARGET_TCP_PROXIES (182243136):

No description available.

TARGET_VPN_GATEWAYS (75029928):

No description available.

TPU_LITE_DEVICE_V5 (449577597):

No description available.

TPU_LITE_PODSLICE_V5 (12708294):

No description available.

TPU_PODSLICE_V4 (214467530):

No description available.

URL_MAPS (378660743):

No description available.

VARIABLE_IPV6_PUBLIC_DELEGATED_PREFIXES (128400161):

No description available.

VPN_GATEWAYS (35620282):

No description available.

VPN_TUNNELS (104327296):

No description available.

XPN_SERVICE_PROJECTS (95191981):

No description available.

class google.cloud.compute_v1.types.QuotaExceededInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional details for quota exceeded error for resource quota.

dimensions

The map holding related quota dimensions.

Type

MutableMapping[str, str]

future_limit

Future quota limit being rolled out. The limit’s unit depends on the quota type or metric.

This field is a member of oneof _future_limit.

Type

float

limit

Current effective quota limit. The limit’s unit depends on the quota type or metric.

This field is a member of oneof _limit.

Type

float

limit_name

The name of the quota limit.

This field is a member of oneof _limit_name.

Type

str

metric_name

The Compute Engine quota metric name.

This field is a member of oneof _metric_name.

Type

str

rollout_status

Rollout status of the future quota limit. Check the RolloutStatus enum for the list of possible values.

This field is a member of oneof _rollout_status.

Type

str

class DimensionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class RolloutStatus(value)

Bases: proto.enums.Enum

Rollout status of the future quota limit.

Values:

UNDEFINED_ROLLOUT_STATUS (0):

A value indicating that the enum field is not set.

IN_PROGRESS (469193735):

IN_PROGRESS - A rollout is in process which will change the limit value to future limit.

ROLLOUT_STATUS_UNSPECIFIED (26864568):

ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The default value.

class google.cloud.compute_v1.types.QuotaStatusWarning(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] Warning of fetching the quotas field for this region. This field is populated only if fetching of the quotas field fails.

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. Check the Code enum for the list of possible values.

This field is a member of oneof _code.

Type

str

data

[Output Only] Metadata about this warning in key: value format. For example: “data”: [ { “key”: “scope”, “value”: “zones/us-east1-d” }

Type

MutableSequence[google.cloud.compute_v1.types.Data]

message

[Output Only] A human-readable description of the warning code.

This field is a member of oneof _message.

Type

str

class Code(value)

Bases: proto.enums.Enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Values:

UNDEFINED_CODE (0):

A value indicating that the enum field is not set.

CLEANUP_FAILED (150308440):

Warning about failed cleanup of transient changes made by a failed operation.

DEPRECATED_RESOURCE_USED (391835586):

A link to a deprecated resource was created.

DEPRECATED_TYPE_USED (346526230):

When deploying and at least one of the resources has a type marked as deprecated

DISK_SIZE_LARGER_THAN_IMAGE_SIZE (369442967):

The user created a boot disk that is larger than image size.

EXPERIMENTAL_TYPE_USED (451954443):

When deploying and at least one of the resources has a type marked as experimental

EXTERNAL_API_WARNING (175546307):

Warning that is present in an external api call

FIELD_VALUE_OVERRIDEN (329669423):

Warning that value of a field has been overridden. Deprecated unused field.

INJECTED_KERNELS_DEPRECATED (417377419):

The operation involved use of an injected kernel, which is deprecated.

INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB (401542606):

A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.

LARGE_DEPLOYMENT_WARNING (481440678):

When deploying a deployment with a exceedingly large number of resources

LIST_OVERHEAD_QUOTA_EXCEED (47618117):

Resource can’t be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.

MISSING_TYPE_DEPENDENCY (344505463):

A resource depends on a missing type

NEXT_HOP_ADDRESS_NOT_ASSIGNED (324964999):

The route’s nextHopIp address is not assigned to an instance on the network.

NEXT_HOP_CANNOT_IP_FORWARD (383382887):

The route’s next hop instance cannot ip forward.

NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE (146748434):

The route’s nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.

NEXT_HOP_INSTANCE_NOT_FOUND (464250446):

The route’s nextHopInstance URL refers to an instance that does not exist.

NEXT_HOP_INSTANCE_NOT_ON_NETWORK (243758146):

The route’s nextHopInstance URL refers to an instance that is not on the same network as the route.

NEXT_HOP_NOT_RUNNING (417081265):

The route’s next hop instance does not have a status of RUNNING.

NOT_CRITICAL_ERROR (105763924):

Error which is not critical. We decided to continue the process despite the mentioned error.

NO_RESULTS_ON_PAGE (30036744):

No results are present on a particular list page.

PARTIAL_SUCCESS (39966469):

Success is reported, but some results may be missing due to errors

REQUIRED_TOS_AGREEMENT (3745539):

The user attempted to use a resource that requires a TOS they have not accepted.

RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING (496728641):

Warning that a resource is in use.

RESOURCE_NOT_DELETED (168598460):

One or more of the resources set to auto-delete could not be deleted because they were in use.

SCHEMA_VALIDATION_IGNORED (275245642):

When a resource schema validation is ignored.

SINGLE_INSTANCE_PROPERTY_TEMPLATE (268305617):

Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.

UNDECLARED_PROPERTIES (390513439):

When undeclared properties in the schema are present

UNREACHABLE (13328052):

A given scope cannot be reached.

class google.cloud.compute_v1.types.RawDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The parameters of the raw disk image.

container_type

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. Check the ContainerType enum for the list of possible values.

This field is a member of oneof _container_type.

Type

str

sha1_checksum

[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.

This field is a member of oneof _sha1_checksum.

Type

str

source

The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

This field is a member of oneof _source.

Type

str

class ContainerType(value)

Bases: proto.enums.Enum

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

Values:

UNDEFINED_CONTAINER_TYPE (0):

A value indicating that the enum field is not set.

TAR (82821):

No description available.

class google.cloud.compute_v1.types.RecreateInstancesInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.RecreateInstances. See the method description for details.

instance_group_manager

The name of the managed instance group.

Type

str

instance_group_managers_recreate_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersRecreateInstancesRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the managed instance group is located.

Type

str

class google.cloud.compute_v1.types.RecreateInstancesRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.RecreateInstances. See the method description for details.

instance_group_manager

Name of the managed instance group.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_instance_group_managers_recreate_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagersRecreateRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.Reference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a reference to a resource.

kind

[Output Only] Type of the resource. Always compute#reference for references.

This field is a member of oneof _kind.

Type

str

reference_type

A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF

This field is a member of oneof _reference_type.

Type

str

referrer

URL of the resource which refers to the target.

This field is a member of oneof _referrer.

Type

str

target

URL of the resource to which this reference points.

This field is a member of oneof _target.

Type

str

class google.cloud.compute_v1.types.Region(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

deprecated

[Output Only] The deprecation status associated with this region.

This field is a member of oneof _deprecated.

Type

google.cloud.compute_v1.types.DeprecationStatus

description

[Output Only] Textual description of the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#region for regions.

This field is a member of oneof _kind.

Type

str

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

quota_status_warning

[Output Only] Warning of fetching the quotas field for this region. This field is populated only if fetching of the quotas field fails.

This field is a member of oneof _quota_status_warning.

Type

google.cloud.compute_v1.types.QuotaStatusWarning

quotas

[Output Only] Quotas assigned to this region.

Type

MutableSequence[google.cloud.compute_v1.types.Quota]

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

status

[Output Only] Status of the region, either UP or DOWN. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

supports_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _supports_pzs.

Type

bool

zones

[Output Only] A list of zones available in this region, in the form of resource URLs.

Type

MutableSequence[str]

class Status(value)

Bases: proto.enums.Enum

[Output Only] Status of the region, either UP or DOWN.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

DOWN (2104482):

No description available.

UP (2715):

No description available.

class google.cloud.compute_v1.types.RegionAddressesMoveRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

description

An optional destination address description if intended to be different from the source.

This field is a member of oneof _description.

Type

str

destination_address

The URL of the destination address to move to. This can be a full or partial URL. For example, the following are all valid URLs to a address: - https://www.googleapis.com/compute/v1/projects/project/regions/region /addresses/address - projects/project/regions/region/addresses/address Note that destination project must be different from the source project. So /regions/region/addresses/address is not valid partial url.

This field is a member of oneof _destination_address.

Type

str

class google.cloud.compute_v1.types.RegionAutoscalerList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of autoscalers.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Autoscaler resources.

Type

MutableSequence[google.cloud.compute_v1.types.Autoscaler]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.RegionDiskTypeList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of DiskType resources.

Type

MutableSequence[google.cloud.compute_v1.types.DiskType]

kind

[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.RegionDisksAddResourcePoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource_policies

Resource policies to be added to this disk.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RegionDisksRemoveResourcePoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource_policies

Resource policies to be removed from this disk.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RegionDisksResizeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

size_gb

The new size of the regional persistent disk, which is specified in GB.

This field is a member of oneof _size_gb.

Type

int

class google.cloud.compute_v1.types.RegionDisksStartAsyncReplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

async_secondary_disk

The secondary disk to start asynchronous replication to. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

This field is a member of oneof _async_secondary_disk.

Type

str

class google.cloud.compute_v1.types.RegionInstanceGroupList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of InstanceGroup resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceGroup resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroup]

kind

The resource type.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.RegionInstanceGroupManagerDeleteInstanceConfigReq(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

RegionInstanceGroupManagers.deletePerInstanceConfigs

names

The list of instance names for which we want to delete per-instance configs on this managed instance group.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RegionInstanceGroupManagerList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of managed instance groups.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceGroupManager resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceGroupManager]

kind

[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.RegionInstanceGroupManagerPatchInstanceConfigReq(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

RegionInstanceGroupManagers.patchPerInstanceConfigs

per_instance_configs

The list of per-instance configurations to insert or patch on this managed instance group.

Type

MutableSequence[google.cloud.compute_v1.types.PerInstanceConfig]

class google.cloud.compute_v1.types.RegionInstanceGroupManagerUpdateInstanceConfigReq(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

RegionInstanceGroupManagers.updatePerInstanceConfigs

per_instance_configs

The list of per-instance configurations to insert or patch on this managed instance group.

Type

MutableSequence[google.cloud.compute_v1.types.PerInstanceConfig]

class google.cloud.compute_v1.types.RegionInstanceGroupManagersAbandonInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RegionInstanceGroupManagersApplyUpdatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

RegionInstanceGroupManagers.applyUpdatesToInstances

all_instances

Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.

This field is a member of oneof _all_instances.

Type

bool

instances

The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Type

MutableSequence[str]

minimal_action

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. Check the MinimalAction enum for the list of possible values.

This field is a member of oneof _minimal_action.

Type

str

most_disruptive_allowed_action

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. Check the MostDisruptiveAllowedAction enum for the list of possible values.

This field is a member of oneof _most_disruptive_allowed_action.

Type

str

class MinimalAction(value)

Bases: proto.enums.Enum

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. Additional supported values which may be not listed in the enum directly due to technical reasons:

NONE REFRESH REPLACE RESTART

Values:

UNDEFINED_MINIMAL_ACTION (0):

A value indicating that the enum field is not set.

class MostDisruptiveAllowedAction(value)

Bases: proto.enums.Enum

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. Additional supported values which may be not listed in the enum directly due to technical reasons:

NONE REFRESH REPLACE RESTART

Values:

UNDEFINED_MOST_DISRUPTIVE_ALLOWED_ACTION (0):

A value indicating that the enum field is not set.

class google.cloud.compute_v1.types.RegionInstanceGroupManagersCreateInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

RegionInstanceGroupManagers.createInstances

instances

[Required] List of specifications of per-instance configs.

Type

MutableSequence[google.cloud.compute_v1.types.PerInstanceConfig]

class google.cloud.compute_v1.types.RegionInstanceGroupManagersDeleteInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Type

MutableSequence[str]

skip_instances_on_validation_error

Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to false and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group’s zone or region.

This field is a member of oneof _skip_instances_on_validation_error.

Type

bool

class google.cloud.compute_v1.types.RegionInstanceGroupManagersListErrorsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

items

[Output Only] The list of errors of the managed instance group.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceManagedByIgmError]

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

class google.cloud.compute_v1.types.RegionInstanceGroupManagersListInstanceConfigsResp(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

items

[Output Only] The list of PerInstanceConfig.

Type

MutableSequence[google.cloud.compute_v1.types.PerInstanceConfig]

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.RegionInstanceGroupManagersListInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

managed_instances

A list of managed instances.

Type

MutableSequence[google.cloud.compute_v1.types.ManagedInstance]

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

class google.cloud.compute_v1.types.RegionInstanceGroupManagersRecreateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RegionInstanceGroupManagersSetTargetPoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This field is a member of oneof _fingerprint.

Type

str

target_pools

The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RegionInstanceGroupManagersSetTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_template

URL of the InstanceTemplate resource from which all new instances will be created.

This field is a member of oneof _instance_template.

Type

str

class google.cloud.compute_v1.types.RegionInstanceGroupsListInstances(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of InstanceWithNamedPorts resources.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceWithNamedPorts]

kind

The resource type.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.RegionInstanceGroupsListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instance_state

Instances in which state should be returned. Valid options are: ‘ALL’, ‘RUNNING’. By default, it lists all instances. Check the InstanceState enum for the list of possible values.

This field is a member of oneof _instance_state.

Type

str

port_name

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.

This field is a member of oneof _port_name.

Type

str

class InstanceState(value)

Bases: proto.enums.Enum

Instances in which state should be returned. Valid options are: ‘ALL’, ‘RUNNING’. By default, it lists all instances.

Values:

UNDEFINED_INSTANCE_STATE (0):

A value indicating that the enum field is not set.

ALL (64897):

Matches any status of the instances, running, non-running and others.

RUNNING (121282975):

Instance is in RUNNING state if it is running.

class google.cloud.compute_v1.types.RegionInstanceGroupsSetNamedPortsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This field is a member of oneof _fingerprint.

Type

str

named_ports

The list of named ports to set for this instance group.

Type

MutableSequence[google.cloud.compute_v1.types.NamedPort]

class google.cloud.compute_v1.types.RegionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of region resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Region resources.

Type

MutableSequence[google.cloud.compute_v1.types.Region]

kind

[Output Only] Type of resource. Always compute#regionList for lists of regions.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.RegionNetworkEndpointGroupsAttachEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_endpoints

The list of network endpoints to be attached.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpoint]

class google.cloud.compute_v1.types.RegionNetworkEndpointGroupsDetachEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

network_endpoints

The list of network endpoints to be detached.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkEndpoint]

class google.cloud.compute_v1.types.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

firewall_policys

[Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network.

Type

MutableSequence[google.cloud.compute_v1.types.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy]

firewalls

Effective firewalls on the network.

Type

MutableSequence[google.cloud.compute_v1.types.Firewall]

class google.cloud.compute_v1.types.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

display_name

[Output Only] The display name of the firewall policy.

This field is a member of oneof _display_name.

Type

str

name

[Output Only] The name of the firewall policy.

This field is a member of oneof _name.

Type

str

rules

[Output only] The rules that apply to the network.

Type

MutableSequence[google.cloud.compute_v1.types.FirewallPolicyRule]

type_

[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

HIERARCHY (69902869):

No description available.

NETWORK (413984270):

No description available.

NETWORK_REGIONAL (190804272):

No description available.

UNSPECIFIED (526786327):

No description available.

class google.cloud.compute_v1.types.RegionSetLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

label_fingerprint

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.

This field is a member of oneof _label_fingerprint.

Type

str

labels

The labels to set for this resource.

Type

MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.RegionSetPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

bindings

Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use ‘policy’ to specify bindings.

Type

MutableSequence[google.cloud.compute_v1.types.Binding]

etag

Flatten Policy to create a backward compatible wire-format. Deprecated. Use ‘policy’ to specify the etag.

This field is a member of oneof _etag.

Type

str

policy

REQUIRED: The complete policy to be applied to the ‘resource’. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

This field is a member of oneof _policy.

Type

google.cloud.compute_v1.types.Policy

class google.cloud.compute_v1.types.RegionTargetHttpsProxiesSetSslCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ssl_certificates

New set of SslCertificate resources to associate with this TargetHttpsProxy resource.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RegionUrlMapsValidateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource

Content of the UrlMap to be validated.

This field is a member of oneof _resource.

Type

google.cloud.compute_v1.types.UrlMap

class google.cloud.compute_v1.types.RemoveAssociationFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.RemoveAssociation. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

name

Name for the attachment that will be removed.

This field is a member of oneof _name.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.RemoveAssociationNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.RemoveAssociation. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

name

Name for the attachment that will be removed.

This field is a member of oneof _name.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.RemoveAssociationRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.RemoveAssociation. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

name

Name for the association that will be removed.

This field is a member of oneof _name.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.RemoveHealthCheckTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.RemoveHealthCheck. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_pool

Name of the target pool to remove health checks from.

Type

str

target_pools_remove_health_check_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetPoolsRemoveHealthCheckRequest

class google.cloud.compute_v1.types.RemoveInstanceTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.RemoveInstance. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_pool

Name of the TargetPool resource to remove instances from.

Type

str

target_pools_remove_instance_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetPoolsRemoveInstanceRequest

class google.cloud.compute_v1.types.RemoveInstancesInstanceGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.RemoveInstances. See the method description for details.

instance_group

The name of the instance group where the specified instances will be removed.

Type

str

instance_groups_remove_instances_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupsRemoveInstancesRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the instance group is located.

Type

str

class google.cloud.compute_v1.types.RemovePeeringNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.RemovePeering. See the method description for details.

network

Name of the network resource to remove peering from.

Type

str

networks_remove_peering_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworksRemovePeeringRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.RemoveResourcePoliciesDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.RemoveResourcePolicies. See the method description for details.

disk

The disk name for this request.

Type

str

disks_remove_resource_policies_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DisksRemoveResourcePoliciesRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.RemoveResourcePoliciesInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.RemoveResourcePolicies. See the method description for details.

instance

The instance name for this request.

Type

str

instances_remove_resource_policies_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesRemoveResourcePoliciesRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.RemoveResourcePoliciesRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.RemoveResourcePolicies. See the method description for details.

disk

The disk name for this request.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_disks_remove_resource_policies_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionDisksRemoveResourcePoliciesRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.RemoveRuleFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.RemoveRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

priority

The priority of the rule to remove from the firewall policy.

This field is a member of oneof _priority.

Type

int

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.RemoveRuleNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.RemoveRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

priority

The priority of the rule to remove from the firewall policy.

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.RemoveRuleRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.RemoveRule. See the method description for details.

firewall_policy

Name of the firewall policy to update.

Type

str

priority

The priority of the rule to remove from the firewall policy.

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.RemoveRuleRegionSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionSecurityPolicies.RemoveRule. See the method description for details.

priority

The priority of the rule to remove from the security policy.

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

security_policy

Name of the security policy to update.

Type

str

class google.cloud.compute_v1.types.RemoveRuleSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.RemoveRule. See the method description for details.

priority

The priority of the rule to remove from the security policy.

This field is a member of oneof _priority.

Type

int

project

Project ID for this request.

Type

str

security_policy

Name of the security policy to update.

Type

str

class google.cloud.compute_v1.types.RequestMirrorPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A policy that specifies how requests intended for the route’s backends are shadowed to a separate mirrored backend service. The load balancer doesn’t wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow.

backend_service

The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.

This field is a member of oneof _backend_service.

Type

str

class google.cloud.compute_v1.types.Reservation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

aggregate_reservation

Reservation for aggregated resources, providing shape flexibility.

This field is a member of oneof _aggregate_reservation.

Type

google.cloud.compute_v1.types.AllocationAggregateReservation

commitment

[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

This field is a member of oneof _commitment.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#reservations for reservations.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

resource_policies

Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.

Type

MutableMapping[str, str]

resource_status

[Output Only] Status information for Reservation resource.

This field is a member of oneof _resource_status.

Type

google.cloud.compute_v1.types.AllocationResourceStatus

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

self_link

[Output Only] Server-defined fully-qualified URL for this resource.

This field is a member of oneof _self_link.

Type

str

share_settings

Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.

This field is a member of oneof _share_settings.

Type

google.cloud.compute_v1.types.ShareSettings

specific_reservation

Reservation for instances with specific machine shapes.

This field is a member of oneof _specific_reservation.

Type

google.cloud.compute_v1.types.AllocationSpecificSKUReservation

specific_reservation_required

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.

This field is a member of oneof _specific_reservation_required.

Type

bool

status

[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

zone

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

This field is a member of oneof _zone.

Type

str

class ResourcePoliciesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

Reservation resources are being allocated.

DELETING (528602024):

Reservation deletion is in progress.

INVALID (530283991):

No description available.

READY (77848963):

Reservation resources have been allocated, and the reservation is ready for use.

UPDATING (494614342):

Reservation update is in progress.

class google.cloud.compute_v1.types.ReservationAffinity(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specifies the reservations that this instance can consume from.

consume_reservation_type

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. Check the ConsumeReservationType enum for the list of possible values.

This field is a member of oneof _consume_reservation_type.

Type

str

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.

This field is a member of oneof _key.

Type

str

values

Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or “projects/different-project/reservations/some-reservation-name” to target a shared reservation in the same zone but in a different project.

Type

MutableSequence[str]

class ConsumeReservationType(value)

Bases: proto.enums.Enum

Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

Values:

UNDEFINED_CONSUME_RESERVATION_TYPE (0):

A value indicating that the enum field is not set.

ANY_RESERVATION (200008121):

Consume any allocation available.

NO_RESERVATION (169322030):

Do not consume from any allocated capacity.

SPECIFIC_RESERVATION (229889055):

Must consume from a specific reservation. Must specify key value fields for specifying the reservations.

UNSPECIFIED (526786327):

No description available.

class google.cloud.compute_v1.types.ReservationAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of reservations.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Allocation resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.ReservationsScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.ReservationList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

str

items

[Output Only] A list of Allocation resources.

Type

MutableSequence[google.cloud.compute_v1.types.Reservation]

kind

[Output Only] Type of resource.Always compute#reservationsList for listsof reservations

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ReservationsResizeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

specific_sku_count

Number of allocated resources can be resized with minimum = 1 and maximum = 1000.

This field is a member of oneof _specific_sku_count.

Type

int

class google.cloud.compute_v1.types.ReservationsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

reservations

A list of reservations contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.Reservation]

warning

Informational warning which replaces the list of reservations when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ResetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Reset. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ResizeDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.Resize. See the method description for details.

disk

The name of the persistent disk.

Type

str

disks_resize_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DisksResizeRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ResizeInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.Resize. See the method description for details.

instance_group_manager

The name of the managed instance group.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

size

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

int

zone

The name of the zone where the managed instance group is located.

Type

str

class google.cloud.compute_v1.types.ResizeRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.Resize. See the method description for details.

disk

Name of the regional persistent disk.

Type

str

project

The project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

region_disks_resize_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionDisksResizeRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.ResizeRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.Resize. See the method description for details.

instance_group_manager

Name of the managed instance group.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

size

Number of instances that should exist in this instance group manager.

Type

int

class google.cloud.compute_v1.types.ResizeReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.Resize. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

reservation

Name of the reservation to update.

Type

str

reservations_resize_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ReservationsResizeRequest

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.ResourceCommitment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Commitment for a particular resource (a Commitment is composed of one or more of these).

accelerator_type

Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.

This field is a member of oneof _accelerator_type.

Type

str

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.

This field is a member of oneof _amount.

Type

int

type_

Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

ACCELERATOR (429815371):

No description available.

LOCAL_SSD (508934896):

No description available.

MEMORY (123056385):

No description available.

UNSPECIFIED (526786327):

No description available.

VCPU (2628978):

No description available.

class google.cloud.compute_v1.types.ResourceGroupReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

group

A URI referencing one of the instance groups or network endpoint groups listed in the backend service.

This field is a member of oneof _group.

Type

str

class google.cloud.compute_v1.types.ResourcePoliciesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource_policies

A list of resourcePolicies contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.ResourcePolicy]

warning

Informational warning which replaces the list of resourcePolicies when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ResourcePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

This field is a member of oneof _description.

Type

str

disk_consistency_group_policy

Resource policy for disk consistency groups.

This field is a member of oneof _disk_consistency_group_policy.

Type

google.cloud.compute_v1.types.ResourcePolicyDiskConsistencyGroupPolicy

group_placement_policy

Resource policy for instances for placement configuration.

This field is a member of oneof _group_placement_policy.

Type

google.cloud.compute_v1.types.ResourcePolicyGroupPlacementPolicy

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

instance_schedule_policy

Resource policy for scheduling instance operations.

This field is a member of oneof _instance_schedule_policy.

Type

google.cloud.compute_v1.types.ResourcePolicyInstanceSchedulePolicy

kind

[Output Only] Type of the resource. Always compute#resource_policies for resource policies.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

region

This field is a member of oneof _region.

Type

str

resource_status

[Output Only] The system status of the resource policy.

This field is a member of oneof _resource_status.

Type

google.cloud.compute_v1.types.ResourcePolicyResourceStatus

self_link

[Output Only] Server-defined fully-qualified URL for this resource.

This field is a member of oneof _self_link.

Type

str

snapshot_schedule_policy

Resource policy for persistent disks for creating snapshots.

This field is a member of oneof _snapshot_schedule_policy.

Type

google.cloud.compute_v1.types.ResourcePolicySnapshotSchedulePolicy

status

[Output Only] The status of resource policy creation. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of resource policy creation.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

Resource policy is being created.

DELETING (528602024):

Resource policy is being deleted.

EXPIRED (482489093):

Resource policy is expired and will not run again.

INVALID (530283991):

No description available.

READY (77848963):

Resource policy is ready to be used.

class google.cloud.compute_v1.types.ResourcePolicyAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of resourcePolicies.

etag

This field is a member of oneof _etag.

Type

str

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of ResourcePolicy resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.ResourcePoliciesScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.ResourcePolicyDailyCycle(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Time window specified for daily operations.

days_in_cycle

Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle.

This field is a member of oneof _days_in_cycle.

Type

int

duration

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

This field is a member of oneof _duration.

Type

str

start_time

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.

This field is a member of oneof _start_time.

Type

str

class google.cloud.compute_v1.types.ResourcePolicyDiskConsistencyGroupPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Resource policy for disk consistency groups.

class google.cloud.compute_v1.types.ResourcePolicyGroupPlacementPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation

availability_domain_count

The number of availability domains to spread instances across. If two instances are in different availability domain, they are not in the same low latency network.

This field is a member of oneof _availability_domain_count.

Type

int

collocation

Specifies network collocation Check the Collocation enum for the list of possible values.

This field is a member of oneof _collocation.

Type

str

vm_count

Number of VMs in this placement group. Google does not recommend that you use this field unless you use a compact policy and you want your policy to work only if it contains this exact number of VMs.

This field is a member of oneof _vm_count.

Type

int

class Collocation(value)

Bases: proto.enums.Enum

Specifies network collocation

Values:

UNDEFINED_COLLOCATION (0):

A value indicating that the enum field is not set.

COLLOCATED (103257554):

No description available.

UNSPECIFIED_COLLOCATION (464308205):

No description available.

class google.cloud.compute_v1.types.ResourcePolicyHourlyCycle(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Time window specified for hourly operations.

duration

[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

This field is a member of oneof _duration.

Type

str

hours_in_cycle

Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.

This field is a member of oneof _hours_in_cycle.

Type

int

start_time

Time within the window to start the operations. It must be in format “HH:MM”, where HH : [00-23] and MM : [00-00] GMT.

This field is a member of oneof _start_time.

Type

str

class google.cloud.compute_v1.types.ResourcePolicyInstanceSchedulePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance.

expiration_time

The expiration time of the schedule. The timestamp is an RFC3339 string.

This field is a member of oneof _expiration_time.

Type

str

start_time

The start time of the schedule. The timestamp is an RFC3339 string.

This field is a member of oneof _start_time.

Type

str

time_zone

Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: https://wikipedia.org/wiki/Tz_database.

This field is a member of oneof _time_zone.

Type

str

vm_start_schedule

Specifies the schedule for starting instances.

This field is a member of oneof _vm_start_schedule.

Type

google.cloud.compute_v1.types.ResourcePolicyInstanceSchedulePolicySchedule

vm_stop_schedule

Specifies the schedule for stopping instances.

This field is a member of oneof _vm_stop_schedule.

Type

google.cloud.compute_v1.types.ResourcePolicyInstanceSchedulePolicySchedule

class google.cloud.compute_v1.types.ResourcePolicyInstanceSchedulePolicySchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Schedule for an instance operation.

schedule

Specifies the frequency for the operation, using the unix-cron format.

This field is a member of oneof _schedule.

Type

str

class google.cloud.compute_v1.types.ResourcePolicyList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

etag

This field is a member of oneof _etag.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

str

items

[Output Only] A list of ResourcePolicy resources.

Type

MutableSequence[google.cloud.compute_v1.types.ResourcePolicy]

kind

[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ResourcePolicyResourceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this “status” field should mimic the structure of ResourcePolicy proto specification.

instance_schedule_policy

[Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field.

This field is a member of oneof _instance_schedule_policy.

Type

google.cloud.compute_v1.types.ResourcePolicyResourceStatusInstanceSchedulePolicyStatus

class google.cloud.compute_v1.types.ResourcePolicyResourceStatusInstanceSchedulePolicyStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

last_run_start_time

[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.

This field is a member of oneof _last_run_start_time.

Type

str

next_run_start_time

[Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.

This field is a member of oneof _next_run_start_time.

Type

str

class google.cloud.compute_v1.types.ResourcePolicySnapshotSchedulePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.

retention_policy

Retention policy applied to snapshots created by this resource policy.

This field is a member of oneof _retention_policy.

Type

google.cloud.compute_v1.types.ResourcePolicySnapshotSchedulePolicyRetentionPolicy

schedule

A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.

This field is a member of oneof _schedule.

Type

google.cloud.compute_v1.types.ResourcePolicySnapshotSchedulePolicySchedule

snapshot_properties

Properties with which snapshots are created such as labels, encryption keys.

This field is a member of oneof _snapshot_properties.

Type

google.cloud.compute_v1.types.ResourcePolicySnapshotSchedulePolicySnapshotProperties

class google.cloud.compute_v1.types.ResourcePolicySnapshotSchedulePolicyRetentionPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Policy for retention of scheduled snapshots.

max_retention_days

Maximum age of the snapshot that is allowed to be kept.

This field is a member of oneof _max_retention_days.

Type

int

on_source_disk_delete

Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. Check the OnSourceDiskDelete enum for the list of possible values.

This field is a member of oneof _on_source_disk_delete.

Type

str

class OnSourceDiskDelete(value)

Bases: proto.enums.Enum

Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.

Values:

UNDEFINED_ON_SOURCE_DISK_DELETE (0):

A value indicating that the enum field is not set.

APPLY_RETENTION_POLICY (535071332):

No description available.

KEEP_AUTO_SNAPSHOTS (258925689):

No description available.

UNSPECIFIED_ON_SOURCE_DISK_DELETE (239140769):

No description available.

class google.cloud.compute_v1.types.ResourcePolicySnapshotSchedulePolicySchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A schedule for disks where the schedueled operations are performed.

daily_schedule

This field is a member of oneof _daily_schedule.

Type

google.cloud.compute_v1.types.ResourcePolicyDailyCycle

hourly_schedule

This field is a member of oneof _hourly_schedule.

Type

google.cloud.compute_v1.types.ResourcePolicyHourlyCycle

weekly_schedule

This field is a member of oneof _weekly_schedule.

Type

google.cloud.compute_v1.types.ResourcePolicyWeeklyCycle

class google.cloud.compute_v1.types.ResourcePolicySnapshotSchedulePolicySnapshotProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specified snapshot properties for scheduled snapshots created by this policy.

chain_name

Chain name that the snapshot is created in.

This field is a member of oneof _chain_name.

Type

str

guest_flush

Indication to perform a ‘guest aware’ snapshot.

This field is a member of oneof _guest_flush.

Type

bool

labels

Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.

Type

MutableMapping[str, str]

storage_locations

Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).

Type

MutableSequence[str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.ResourcePolicyWeeklyCycle(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Time window specified for weekly operations.

day_of_weeks

Up to 7 intervals/windows, one for each day of the week.

Type

MutableSequence[google.cloud.compute_v1.types.ResourcePolicyWeeklyCycleDayOfWeek]

class google.cloud.compute_v1.types.ResourcePolicyWeeklyCycleDayOfWeek(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

day

Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. Check the Day enum for the list of possible values.

This field is a member of oneof _day.

Type

str

duration

[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

This field is a member of oneof _duration.

Type

str

start_time

Time within the window to start the operations. It must be in format “HH:MM”, where HH : [00-23] and MM : [00-00] GMT.

This field is a member of oneof _start_time.

Type

str

class Day(value)

Bases: proto.enums.Enum

Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

Values:

UNDEFINED_DAY (0):

A value indicating that the enum field is not set.

FRIDAY (471398751):

No description available.

INVALID (530283991):

No description available.

MONDAY (132310288):

No description available.

SATURDAY (279037881):

No description available.

SUNDAY (309626320):

No description available.

THURSDAY (207198682):

No description available.

TUESDAY (277509677):

No description available.

WEDNESDAY (422029110):

No description available.

class google.cloud.compute_v1.types.ResourceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.

physical_host

[Output Only] An opaque ID of the host on which the VM is running.

This field is a member of oneof _physical_host.

Type

str

scheduling

This field is a member of oneof _scheduling.

Type

google.cloud.compute_v1.types.ResourceStatusScheduling

upcoming_maintenance

This field is a member of oneof _upcoming_maintenance.

Type

google.cloud.compute_v1.types.UpcomingMaintenance

class google.cloud.compute_v1.types.ResourceStatusScheduling(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

availability_domain

Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

This field is a member of oneof _availability_domain.

Type

int

class google.cloud.compute_v1.types.ResumeInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Resume. See the method description for details.

instance

Name of the instance resource to resume.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.Route(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

as_paths

[Output Only] AS path.

Type

MutableSequence[google.cloud.compute_v1.types.RouteAsPath]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this field when you create the resource.

This field is a member of oneof _description.

Type

str

dest_range

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.

This field is a member of oneof _dest_range.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of this resource. Always compute#routes for Route resources.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

network

Fully-qualified URL of the network that this route applies to.

This field is a member of oneof _network.

Type

str

next_hop_gateway

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

This field is a member of oneof _next_hop_gateway.

Type

str

next_hop_hub

[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

This field is a member of oneof _next_hop_hub.

Type

str

next_hop_ilb

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.

This field is a member of oneof _next_hop_ilb.

Type

str

next_hop_instance

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

This field is a member of oneof _next_hop_instance.

Type

str

next_hop_ip

The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.

This field is a member of oneof _next_hop_ip.

Type

str

next_hop_network

The URL of the local network if it should handle matching packets.

This field is a member of oneof _next_hop_network.

Type

str

next_hop_peering

[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

This field is a member of oneof _next_hop_peering.

Type

str

next_hop_vpn_tunnel

The URL to a VpnTunnel that should handle matching packets.

This field is a member of oneof _next_hop_vpn_tunnel.

Type

str

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.

This field is a member of oneof _priority.

Type

int

route_status

[Output only] The status of the route. Check the RouteStatus enum for the list of possible values.

This field is a member of oneof _route_status.

Type

str

route_type

[Output Only] The type of this route, which can be one of the following values: - ‘TRANSIT’ for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - ‘SUBNET’ for a route from a subnet of the VPC - ‘BGP’ for a route learned from a BGP peer of this router - ‘STATIC’ for a static route Check the RouteType enum for the list of possible values.

This field is a member of oneof _route_type.

Type

str

self_link

[Output Only] Server-defined fully-qualified URL for this resource.

This field is a member of oneof _self_link.

Type

str

tags

A list of instance tags to which this route applies.

Type

MutableSequence[str]

warnings

[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Type

MutableSequence[google.cloud.compute_v1.types.Warnings]

class RouteStatus(value)

Bases: proto.enums.Enum

[Output only] The status of the route.

Values:

UNDEFINED_ROUTE_STATUS (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

This route is processed and active.

DROPPED (496235424):

The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example

INACTIVE (270421099):

This route is processed but inactive due to failure from the backend. The backend may have rejected the route

PENDING (35394935):

This route is being processed internally. The status will change once processed.

class RouteType(value)

Bases: proto.enums.Enum

[Output Only] The type of this route, which can be one of the following values: - ‘TRANSIT’ for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - ‘SUBNET’ for a route from a subnet of the VPC - ‘BGP’ for a route learned from a BGP peer of this router - ‘STATIC’ for a static route

Values:

UNDEFINED_ROUTE_TYPE (0):

A value indicating that the enum field is not set.

BGP (65707):

No description available.

STATIC (308331118):

No description available.

SUBNET (309278557):

No description available.

TRANSIT (187793843):

No description available.

class google.cloud.compute_v1.types.RouteAsPath(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

as_lists

[Output Only] The AS numbers of the AS Path.

Type

MutableSequence[int]

path_segment_type

[Output Only] The type of the AS Path, which can be one of the following values: - ‘AS_SET’: unordered set of autonomous systems that the route in has traversed - ‘AS_SEQUENCE’: ordered set of autonomous systems that the route has traversed - ‘AS_CONFED_SEQUENCE’: ordered set of Member Autonomous Systems in the local confederation that the route has traversed - ‘AS_CONFED_SET’: unordered set of Member Autonomous Systems in the local confederation that the route has traversed Check the PathSegmentType enum for the list of possible values.

This field is a member of oneof _path_segment_type.

Type

str

class PathSegmentType(value)

Bases: proto.enums.Enum

[Output Only] The type of the AS Path, which can be one of the following values: - ‘AS_SET’: unordered set of autonomous systems that the route in has traversed - ‘AS_SEQUENCE’: ordered set of autonomous systems that the route has traversed - ‘AS_CONFED_SEQUENCE’: ordered set of Member Autonomous Systems in the local confederation that the route has traversed - ‘AS_CONFED_SET’: unordered set of Member Autonomous Systems in the local confederation that the route has traversed

Values:

UNDEFINED_PATH_SEGMENT_TYPE (0):

A value indicating that the enum field is not set.

AS_CONFED_SEQUENCE (222152624):

No description available.

AS_CONFED_SET (374040307):

No description available.

AS_SEQUENCE (106735918):

No description available.

AS_SET (329846453):

No description available.

class google.cloud.compute_v1.types.RouteList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of Route resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Route resources.

Type

MutableSequence[google.cloud.compute_v1.types.Route]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.Router(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

bgp

BGP information specific to this router.

This field is a member of oneof _bgp.

Type

google.cloud.compute_v1.types.RouterBgp

bgp_peers

BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

Type

MutableSequence[google.cloud.compute_v1.types.RouterBgpPeer]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

encrypted_interconnect_router

Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).

This field is a member of oneof _encrypted_interconnect_router.

Type

bool

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

interfaces

Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.

Type

MutableSequence[google.cloud.compute_v1.types.RouterInterface]

kind

[Output Only] Type of resource. Always compute#router for routers.

This field is a member of oneof _kind.

Type

str

md5_authentication_keys

Keys used for MD5 authentication.

Type

MutableSequence[google.cloud.compute_v1.types.RouterMd5AuthenticationKey]

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.

This field is a member of oneof _name.

Type

str

nats

A list of NAT services created in this router.

Type

MutableSequence[google.cloud.compute_v1.types.RouterNat]

network

URI of the network to which this router belongs.

This field is a member of oneof _network.

Type

str

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.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

class google.cloud.compute_v1.types.RouterAdvertisedIpRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Description-tagged IP ranges for the router to advertise.

description

User-specified description for the IP range.

This field is a member of oneof _description.

Type

str

range_

The IP range to advertise. The value must be a CIDR-formatted string.

This field is a member of oneof _range.

Type

str

class google.cloud.compute_v1.types.RouterAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of routers.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Router resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.RoutersScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.RouterBgp(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

advertise_mode

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. Check the AdvertiseMode enum for the list of possible values.

This field is a member of oneof _advertise_mode.

Type

str

advertised_groups

User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. Check the AdvertisedGroups enum for the list of possible values.

Type

MutableSequence[str]

advertised_ip_ranges

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Type

MutableSequence[google.cloud.compute_v1.types.RouterAdvertisedIpRange]

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.

This field is a member of oneof _asn.

Type

int

identifier_range

Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this “router ID”.

This field is a member of oneof _identifier_range.

Type

str

keepalive_interval

The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer’s hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

This field is a member of oneof _keepalive_interval.

Type

int

class AdvertiseMode(value)

Bases: proto.enums.Enum

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

Values:

UNDEFINED_ADVERTISE_MODE (0):

A value indicating that the enum field is not set.

CUSTOM (388595569):

No description available.

DEFAULT (115302945):

No description available.

class AdvertisedGroups(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_ADVERTISED_GROUPS (0):

A value indicating that the enum field is not set.

ALL_SUBNETS (3622872):

Advertise all available subnets (including peer VPC subnets).

class google.cloud.compute_v1.types.RouterBgpPeer(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

advertise_mode

User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.

This field is a member of oneof _advertise_mode.

Type

str

advertised_groups

User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router’s own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the “bgp” message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. Check the AdvertisedGroups enum for the list of possible values.

Type

MutableSequence[str]

advertised_ip_ranges

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the “bgp” message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Type

MutableSequence[google.cloud.compute_v1.types.RouterAdvertisedIpRange]

advertised_route_priority

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.

This field is a member of oneof _advertised_route_priority.

Type

int

bfd

BFD configuration for the BGP peering.

This field is a member of oneof _bfd.

Type

google.cloud.compute_v1.types.RouterBgpPeerBfd

custom_learned_ip_ranges

A list of user-defined custom learned route IP address ranges for a BGP session.

Type

MutableSequence[google.cloud.compute_v1.types.RouterBgpPeerCustomLearnedIpRange]

custom_learned_route_priority

The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don’t provide a value, Google Cloud assigns a priority of 100 to the ranges.

This field is a member of oneof _custom_learned_route_priority.

Type

int

enable

The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. Check the Enable enum for the list of possible values.

This field is a member of oneof _enable.

Type

str

enable_ipv4

Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.

This field is a member of oneof _enable_ipv4.

Type

bool

enable_ipv6

Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.

This field is a member of oneof _enable_ipv6.

Type

bool

export_policies

List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.

Type

MutableSequence[str]

import_policies

List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.

Type

MutableSequence[str]

interface_name

Name of the interface the BGP peer is associated with.

This field is a member of oneof _interface_name.

Type

str

ip_address

IP address of the interface inside Google Cloud Platform.

This field is a member of oneof _ip_address.

Type

str

ipv4_nexthop_address

IPv4 address of the interface inside Google Cloud Platform.

This field is a member of oneof _ipv4_nexthop_address.

Type

str

ipv6_nexthop_address

IPv6 address of the interface inside Google Cloud Platform.

This field is a member of oneof _ipv6_nexthop_address.

Type

str

management_type

[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. Check the ManagementType enum for the list of possible values.

This field is a member of oneof _management_type.

Type

str

md5_authentication_key_name

Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.

This field is a member of oneof _md5_authentication_key_name.

Type

str

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.

This field is a member of oneof _name.

Type

str

peer_asn

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

This field is a member of oneof _peer_asn.

Type

int

peer_ip_address

IP address of the BGP interface outside Google Cloud Platform.

This field is a member of oneof _peer_ip_address.

Type

str

peer_ipv4_nexthop_address

IPv4 address of the BGP interface outside Google Cloud Platform.

This field is a member of oneof _peer_ipv4_nexthop_address.

Type

str

peer_ipv6_nexthop_address

IPv6 address of the BGP interface outside Google Cloud Platform.

This field is a member of oneof _peer_ipv6_nexthop_address.

Type

str

router_appliance_instance

URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

This field is a member of oneof _router_appliance_instance.

Type

str

class AdvertiseMode(value)

Bases: proto.enums.Enum

User-specified flag to indicate which mode to use for advertisement.

Values:

UNDEFINED_ADVERTISE_MODE (0):

A value indicating that the enum field is not set.

CUSTOM (388595569):

No description available.

DEFAULT (115302945):

No description available.

class AdvertisedGroups(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_ADVERTISED_GROUPS (0):

A value indicating that the enum field is not set.

ALL_SUBNETS (3622872):

Advertise all available subnets (including peer VPC subnets).

class Enable(value)

Bases: proto.enums.Enum

The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Values:

UNDEFINED_ENABLE (0):

A value indicating that the enum field is not set.

FALSE (66658563):

No description available.

TRUE (2583950):

No description available.

class ManagementType(value)

Bases: proto.enums.Enum

[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Values:

UNDEFINED_MANAGEMENT_TYPE (0):

A value indicating that the enum field is not set.

MANAGED_BY_ATTACHMENT (458926411):

The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.

MANAGED_BY_USER (317294067):

Default value, the BGP peer is manually created and managed by user.

class google.cloud.compute_v1.types.RouterBgpPeerBfd(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

min_receive_interval

The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.

This field is a member of oneof _min_receive_interval.

Type

int

min_transmit_interval

The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.

This field is a member of oneof _min_transmit_interval.

Type

int

multiplier

The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.

This field is a member of oneof _multiplier.

Type

int

session_initialization_mode

The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. Check the SessionInitializationMode enum for the list of possible values.

This field is a member of oneof _session_initialization_mode.

Type

str

class SessionInitializationMode(value)

Bases: proto.enums.Enum

The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.

Values:

UNDEFINED_SESSION_INITIALIZATION_MODE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

No description available.

DISABLED (516696700):

No description available.

PASSIVE (462813959):

No description available.

class google.cloud.compute_v1.types.RouterBgpPeerCustomLearnedIpRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

range_

The custom learned route IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

This field is a member of oneof _range.

Type

str

class google.cloud.compute_v1.types.RouterInterface(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ip_range

IP address and range of the interface. - For Internet Protocol version 4 (IPv4), 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 IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router’s VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose.

This field is a member of oneof _ip_range.

Type

str

ip_version

IP version of this interface. Check the IpVersion enum for the list of possible values.

This field is a member of oneof _ip_version.

Type

str

linked_interconnect_attachment

URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.

This field is a member of oneof _linked_interconnect_attachment.

Type

str

linked_vpn_tunnel

URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.

This field is a member of oneof _linked_vpn_tunnel.

Type

str

management_type

[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. Check the ManagementType enum for the list of possible values.

This field is a member of oneof _management_type.

Type

str

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.

This field is a member of oneof _name.

Type

str

private_ip_address

The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

This field is a member of oneof _private_ip_address.

Type

str

redundant_interface

Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

This field is a member of oneof _redundant_interface.

Type

str

subnetwork

The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

This field is a member of oneof _subnetwork.

Type

str

class IpVersion(value)

Bases: proto.enums.Enum

IP version of this interface.

Values:

UNDEFINED_IP_VERSION (0):

A value indicating that the enum field is not set.

IPV4 (2254341):

No description available.

IPV6 (2254343):

No description available.

class ManagementType(value)

Bases: proto.enums.Enum

[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Values:

UNDEFINED_MANAGEMENT_TYPE (0):

A value indicating that the enum field is not set.

MANAGED_BY_ATTACHMENT (458926411):

The interface is automatically created for PARTNER type InterconnectAttachment, Google will automatically create/update/delete this interface when the PARTNER InterconnectAttachment is created/provisioned/deleted. This type of interface cannot be manually managed by user.

MANAGED_BY_USER (317294067):

Default value, the interface is manually created and managed by user.

class google.cloud.compute_v1.types.RouterList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of Router resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Router resources.

Type

MutableSequence[google.cloud.compute_v1.types.Router]

kind

[Output Only] Type of resource. Always compute#router for routers.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.RouterMd5AuthenticationKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

key

[Input only] Value of the key. For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.

This field is a member of oneof _key.

Type

str

name

Name used to identify the key. Must be unique within a router. Must be referenced by exactly one bgpPeer. Must comply with RFC1035.

This field is a member of oneof _name.

Type

str

class google.cloud.compute_v1.types.RouterNat(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

auto_network_tier

The network tier to use when automatically reserving NAT IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, then the current project-level default tier is used. Check the AutoNetworkTier enum for the list of possible values.

This field is a member of oneof _auto_network_tier.

Type

str

drain_nat_ips

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

Type

MutableSequence[str]

enable_dynamic_port_allocation

Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.

This field is a member of oneof _enable_dynamic_port_allocation.

Type

bool

enable_endpoint_independent_mapping

This field is a member of oneof _enable_endpoint_independent_mapping.

Type

bool

endpoint_types

List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM Check the EndpointTypes enum for the list of possible values.

Type

MutableSequence[str]

icmp_idle_timeout_sec

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

This field is a member of oneof _icmp_idle_timeout_sec.

Type

int

log_config

Configure logging on this NAT.

This field is a member of oneof _log_config.

Type

google.cloud.compute_v1.types.RouterNatLogConfig

max_ports_per_vm

Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.

This field is a member of oneof _max_ports_per_vm.

Type

int

min_ports_per_vm

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.

This field is a member of oneof _min_ports_per_vm.

Type

int

name

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

This field is a member of oneof _name.

Type

str

nat_ip_allocate_option

Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can’t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. Check the NatIpAllocateOption enum for the list of possible values.

This field is a member of oneof _nat_ip_allocate_option.

Type

str

nat_ips

A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

Type

MutableSequence[str]

rules

A list of rules associated with this NAT.

Type

MutableSequence[google.cloud.compute_v1.types.RouterNatRule]

source_subnetwork_ip_ranges_to_nat

Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region. Check the SourceSubnetworkIpRangesToNat enum for the list of possible values.

This field is a member of oneof _source_subnetwork_ip_ranges_to_nat.

Type

str

subnetworks

A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

Type

MutableSequence[google.cloud.compute_v1.types.RouterNatSubnetworkToNat]

tcp_established_idle_timeout_sec

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

This field is a member of oneof _tcp_established_idle_timeout_sec.

Type

int

tcp_time_wait_timeout_sec

Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

This field is a member of oneof _tcp_time_wait_timeout_sec.

Type

int

tcp_transitory_idle_timeout_sec

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

This field is a member of oneof _tcp_transitory_idle_timeout_sec.

Type

int

type_

Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

udp_idle_timeout_sec

Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

This field is a member of oneof _udp_idle_timeout_sec.

Type

int

class AutoNetworkTier(value)

Bases: proto.enums.Enum

The network tier to use when automatically reserving NAT IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, then the current project-level default tier is used.

Values:

UNDEFINED_AUTO_NETWORK_TIER (0):

A value indicating that the enum field is not set.

FIXED_STANDARD (310464328):

Public internet quality with fixed bandwidth.

PREMIUM (399530551):

High quality, Google-grade network tier, support for all networking products.

STANDARD (484642493):

Public internet quality, only limited support for other networking products.

STANDARD_OVERRIDES_FIXED_STANDARD (465847234):

(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

class EndpointTypes(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_ENDPOINT_TYPES (0):

A value indicating that the enum field is not set.

ENDPOINT_TYPE_MANAGED_PROXY_LB (439196930):

This is used for regional Application Load Balancers (internal and external) and regional proxy Network Load Balancers (internal and external) endpoints.

ENDPOINT_TYPE_SWG (159344456):

This is used for Secure Web Gateway endpoints.

ENDPOINT_TYPE_VM (57095474):

This is the default.

class NatIpAllocateOption(value)

Bases: proto.enums.Enum

Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can’t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Values:

UNDEFINED_NAT_IP_ALLOCATE_OPTION (0):

A value indicating that the enum field is not set.

AUTO_ONLY (182333500):

Nat IPs are allocated by GCP; customers can not specify any Nat IPs.

MANUAL_ONLY (261251205):

Only use Nat IPs provided by customers. When specified Nat IPs are not enough then the Nat service fails for new VMs.

class SourceSubnetworkIpRangesToNat(value)

Bases: proto.enums.Enum

Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region.

Values:

UNDEFINED_SOURCE_SUBNETWORK_IP_RANGES_TO_NAT (0):

A value indicating that the enum field is not set.

ALL_SUBNETWORKS_ALL_IP_RANGES (179964376):

All the IP ranges in every Subnetwork are allowed to Nat.

ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES (185573819):

All the primary IP ranges in every Subnetwork are allowed to Nat.

LIST_OF_SUBNETWORKS (517542270):

A list of Subnetworks are allowed to Nat (specified in the field subnetwork below)

class Type(value)

Bases: proto.enums.Enum

Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

PRIVATE (403485027):

NAT used for private IP translation.

PUBLIC (223389289):

NAT used for public IP translation. This is the default.

class google.cloud.compute_v1.types.RouterNatLogConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration of logging on a NAT.

enable

Indicates whether or not to export logs. This is false by default.

This field is a member of oneof _enable.

Type

bool

filter

Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful. Check the Filter enum for the list of possible values.

This field is a member of oneof _filter.

Type

str

class Filter(value)

Bases: proto.enums.Enum

Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Values:

UNDEFINED_FILTER (0):

A value indicating that the enum field is not set.

ALL (64897):

Export logs for all (successful and unsuccessful) connections.

ERRORS_ONLY (307484672):

Export logs for connection failures only.

TRANSLATIONS_ONLY (357212649):

Export logs for successful connections only.

class google.cloud.compute_v1.types.RouterNatRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

action

The action to be enforced for traffic that matches this rule.

This field is a member of oneof _action.

Type

google.cloud.compute_v1.types.RouterNatRuleAction

description

An optional description of this rule.

This field is a member of oneof _description.

Type

str

match

CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding action is enforced. The following examples are valid match expressions for public NAT: inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16') destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8' The following example is a valid match expression for private NAT: nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'

This field is a member of oneof _match.

Type

str

rule_number

An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

This field is a member of oneof _rule_number.

Type

int

class google.cloud.compute_v1.types.RouterNatRuleAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

source_nat_active_ips

A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT.

Type

MutableSequence[str]

source_nat_active_ranges

A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT.

Type

MutableSequence[str]

source_nat_drain_ips

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT.

Type

MutableSequence[str]

source_nat_drain_ranges

A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RouterNatSubnetworkToNat(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines the IP ranges that want to use NAT for a subnetwork.

name

URL for the subnetwork resource that will use NAT.

This field is a member of oneof _name.

Type

str

secondary_ip_range_names

A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if “LIST_OF_SECONDARY_IP_RANGES” is one of the values in source_ip_ranges_to_nat.

Type

MutableSequence[str]

source_ip_ranges_to_nat

Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: [“PRIMARY_IP_RANGE”, “LIST_OF_SECONDARY_IP_RANGES”] Default: [ALL_IP_RANGES] Check the SourceIpRangesToNat enum for the list of possible values.

Type

MutableSequence[str]

class SourceIpRangesToNat(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_SOURCE_IP_RANGES_TO_NAT (0):

A value indicating that the enum field is not set.

ALL_IP_RANGES (35608496):

The primary and all the secondary ranges are allowed to Nat.

LIST_OF_SECONDARY_IP_RANGES (192289308):

A list of secondary ranges are allowed to Nat.

PRIMARY_IP_RANGE (297109954):

The primary range is allowed to Nat.

class google.cloud.compute_v1.types.RouterStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

best_routes

A list of the best dynamic routes for this Cloud Router’s Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region’s VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions.

Type

MutableSequence[google.cloud.compute_v1.types.Route]

best_routes_for_router

A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router.

Type

MutableSequence[google.cloud.compute_v1.types.Route]

bgp_peer_status

Type

MutableSequence[google.cloud.compute_v1.types.RouterStatusBgpPeerStatus]

nat_status

Type

MutableSequence[google.cloud.compute_v1.types.RouterStatusNatStatus]

network

URI of the network to which this router belongs.

This field is a member of oneof _network.

Type

str

class google.cloud.compute_v1.types.RouterStatusBgpPeerStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

advertised_routes

Routes that were advertised to the remote BGP peer

Type

MutableSequence[google.cloud.compute_v1.types.Route]

bfd_status

This field is a member of oneof _bfd_status.

Type

google.cloud.compute_v1.types.BfdStatus

enable_ipv4

Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.

This field is a member of oneof _enable_ipv4.

Type

bool

enable_ipv6

Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.

This field is a member of oneof _enable_ipv6.

Type

bool

ip_address

IP address of the local BGP interface.

This field is a member of oneof _ip_address.

Type

str

ipv4_nexthop_address

IPv4 address of the local BGP interface.

This field is a member of oneof _ipv4_nexthop_address.

Type

str

ipv6_nexthop_address

IPv6 address of the local BGP interface.

This field is a member of oneof _ipv6_nexthop_address.

Type

str

linked_vpn_tunnel

URL of the VPN tunnel that this BGP peer controls.

This field is a member of oneof _linked_vpn_tunnel.

Type

str

md5_auth_enabled

Informs whether MD5 authentication is enabled on this BGP peer.

This field is a member of oneof _md5_auth_enabled.

Type

bool

name

Name of this BGP peer. Unique within the Routers resource.

This field is a member of oneof _name.

Type

str

num_learned_routes

Number of routes learned from the remote BGP Peer.

This field is a member of oneof _num_learned_routes.

Type

int

peer_ip_address

IP address of the remote BGP interface.

This field is a member of oneof _peer_ip_address.

Type

str

peer_ipv4_nexthop_address

IPv4 address of the remote BGP interface.

This field is a member of oneof _peer_ipv4_nexthop_address.

Type

str

peer_ipv6_nexthop_address

IPv6 address of the remote BGP interface.

This field is a member of oneof _peer_ipv6_nexthop_address.

Type

str

router_appliance_instance

[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session.

This field is a member of oneof _router_appliance_instance.

Type

str

state

The state of the BGP session. For a list of possible values for this field, see BGP session states.

This field is a member of oneof _state.

Type

str

status

Status of the BGP peer: {UP, DOWN} Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

status_reason

Indicates why particular status was returned. Check the StatusReason enum for the list of possible values.

This field is a member of oneof _status_reason.

Type

str

uptime

Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds

This field is a member of oneof _uptime.

Type

str

uptime_seconds

Time this session has been up, in seconds. Format: 145

This field is a member of oneof _uptime_seconds.

Type

str

class Status(value)

Bases: proto.enums.Enum

Status of the BGP peer: {UP, DOWN}

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

DOWN (2104482):

No description available.

UNKNOWN (433141802):

No description available.

UP (2715):

No description available.

class StatusReason(value)

Bases: proto.enums.Enum

Indicates why particular status was returned.

Values:

UNDEFINED_STATUS_REASON (0):

A value indicating that the enum field is not set.

IPV4_PEER_ON_IPV6_ONLY_CONNECTION (435936662):

BGP peer disabled because it requires IPv4 but the underlying connection is IPv6-only.

IPV6_PEER_ON_IPV4_ONLY_CONNECTION (436304082):

BGP peer disabled because it requires IPv6 but the underlying connection is IPv4-only.

MD5_AUTH_INTERNAL_PROBLEM (140462259):

Indicates internal problems with configuration of MD5 authentication. This particular reason can only be returned when md5AuthEnabled is true and status is DOWN.

STATUS_REASON_UNSPECIFIED (394331913):

No description available.

class google.cloud.compute_v1.types.RouterStatusNatStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Status of a NAT contained in this router.

auto_allocated_nat_ips

A list of IPs auto-allocated for NAT. Example: [“1.1.1.1”, “129.2.16.89”]

Type

MutableSequence[str]

drain_auto_allocated_nat_ips

A list of IPs auto-allocated for NAT that are in drain mode. Example: [“1.1.1.1”, “179.12.26.133”].

Type

MutableSequence[str]

drain_user_allocated_nat_ips

A list of IPs user-allocated for NAT that are in drain mode. Example: [“1.1.1.1”, “179.12.26.133”].

Type

MutableSequence[str]

min_extra_nat_ips_needed

The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is not used.

This field is a member of oneof _min_extra_nat_ips_needed.

Type

int

name

Unique name of this NAT.

This field is a member of oneof _name.

Type

str

num_vm_endpoints_with_nat_mappings

Number of VM endpoints (i.e., Nics) that can use NAT.

This field is a member of oneof _num_vm_endpoints_with_nat_mappings.

Type

int

rule_status

Status of rules in this NAT.

Type

MutableSequence[google.cloud.compute_v1.types.RouterStatusNatStatusNatRuleStatus]

user_allocated_nat_ip_resources

A list of fully qualified URLs of reserved IP address resources.

Type

MutableSequence[str]

user_allocated_nat_ips

A list of IPs user-allocated for NAT. They will be raw IP strings like “179.12.26.133”.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.RouterStatusNatStatusNatRuleStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Status of a NAT Rule contained in this NAT.

active_nat_ips

A list of active IPs for NAT. Example: [“1.1.1.1”, “179.12.26.133”].

Type

MutableSequence[str]

drain_nat_ips

A list of IPs for NAT that are in drain mode. Example: [“1.1.1.1”, “179.12.26.133”].

Type

MutableSequence[str]

min_extra_ips_needed

The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.

This field is a member of oneof _min_extra_ips_needed.

Type

int

num_vm_endpoints_with_nat_mappings

Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.

This field is a member of oneof _num_vm_endpoints_with_nat_mappings.

Type

int

rule_number

Rule number of the rule.

This field is a member of oneof _rule_number.

Type

int

class google.cloud.compute_v1.types.RouterStatusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

result

This field is a member of oneof _result.

Type

google.cloud.compute_v1.types.RouterStatus

class google.cloud.compute_v1.types.RoutersPreviewResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

resource

Preview of given router.

This field is a member of oneof _resource.

Type

google.cloud.compute_v1.types.Router

class google.cloud.compute_v1.types.RoutersScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

routers

A list of routers contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.Router]

warning

Informational warning which replaces the list of routers when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SSLHealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

port

The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.

This field is a member of oneof _port.

Type

int

port_name

Not supported.

This field is a member of oneof _port_name.

Type

str

port_specification

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Check the PortSpecification enum for the list of possible values.

This field is a member of oneof _port_specification.

Type

str

proxy_header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

request

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake.

This field is a member of oneof _request.

Type

str

response

Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

This field is a member of oneof _response.

Type

str

class PortSpecification(value)

Bases: proto.enums.Enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports.

Values:

UNDEFINED_PORT_SPECIFICATION (0):

A value indicating that the enum field is not set.

USE_FIXED_PORT (190235748):

The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.

USE_NAMED_PORT (349300671):

Not supported.

USE_SERVING_PORT (362637516):

For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.

class ProxyHeader(value)

Bases: proto.enums.Enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.SavedAttachedDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.

auto_delete

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

This field is a member of oneof _auto_delete.

Type

bool

boot

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

This field is a member of oneof _boot.

Type

bool

device_name

Specifies the name of the disk attached to the source instance.

This field is a member of oneof _device_name.

Type

str

disk_encryption_key

The encryption key for the disk.

This field is a member of oneof _disk_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

disk_size_gb

The size of the disk in base-2 GB.

This field is a member of oneof _disk_size_gb.

Type

int

disk_type

[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd

This field is a member of oneof _disk_type.

Type

str

guest_os_features

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Type

MutableSequence[google.cloud.compute_v1.types.GuestOsFeature]

index

Specifies zero-based index of the disk that is attached to the source instance.

This field is a member of oneof _index.

Type

int

interface

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. Check the Interface enum for the list of possible values.

This field is a member of oneof _interface.

Type

str

kind

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

This field is a member of oneof _kind.

Type

str

licenses

[Output Only] Any valid publicly visible licenses.

Type

MutableSequence[str]

mode

The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY. Check the Mode enum for the list of possible values.

This field is a member of oneof _mode.

Type

str

source

Specifies a URL of the disk attached to the source instance.

This field is a member of oneof _source.

Type

str

storage_bytes

[Output Only] A size of the storage used by the disk’s snapshot by this machine image.

This field is a member of oneof _storage_bytes.

Type

int

storage_bytes_status

[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. Check the StorageBytesStatus enum for the list of possible values.

This field is a member of oneof _storage_bytes_status.

Type

str

type_

Specifies the type of the attached disk, either SCRATCH or PERSISTENT. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Interface(value)

Bases: proto.enums.Enum

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.

Values:

UNDEFINED_INTERFACE (0):

A value indicating that the enum field is not set.

NVME (2408800):

No description available.

SCSI (2539686):

No description available.

class Mode(value)

Bases: proto.enums.Enum

The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.

Values:

UNDEFINED_MODE (0):

A value indicating that the enum field is not set.

READ_ONLY (91950261):

Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.

READ_WRITE (173607894):

[Default] Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.

class StorageBytesStatus(value)

Bases: proto.enums.Enum

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

Values:

UNDEFINED_STORAGE_BYTES_STATUS (0):

A value indicating that the enum field is not set.

UPDATING (494614342):

No description available.

UP_TO_DATE (101306702):

No description available.

class Type(value)

Bases: proto.enums.Enum

Specifies the type of the attached disk, either SCRATCH or PERSISTENT.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

PERSISTENT (460683927):

No description available.

SCRATCH (496778970):

No description available.

class google.cloud.compute_v1.types.SavedDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An instance-attached disk resource.

architecture

[Output Only] The architecture of the attached disk. Check the Architecture enum for the list of possible values.

This field is a member of oneof _architecture.

Type

str

kind

[Output Only] Type of the resource. Always compute#savedDisk for attached disks.

This field is a member of oneof _kind.

Type

str

source_disk

Specifies a URL of the disk attached to the source instance.

This field is a member of oneof _source_disk.

Type

str

storage_bytes

[Output Only] Size of the individual disk snapshot used by this machine image.

This field is a member of oneof _storage_bytes.

Type

int

storage_bytes_status

[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. Check the StorageBytesStatus enum for the list of possible values.

This field is a member of oneof _storage_bytes_status.

Type

str

class Architecture(value)

Bases: proto.enums.Enum

[Output Only] The architecture of the attached disk.

Values:

UNDEFINED_ARCHITECTURE (0):

A value indicating that the enum field is not set.

ARCHITECTURE_UNSPECIFIED (394750507):

Default value indicating Architecture is not set.

ARM64 (62547450):

Machines with architecture ARM64

X86_64 (425300551):

Machines with architecture X86_64

class StorageBytesStatus(value)

Bases: proto.enums.Enum

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

Values:

UNDEFINED_STORAGE_BYTES_STATUS (0):

A value indicating that the enum field is not set.

UPDATING (494614342):

No description available.

UP_TO_DATE (101306702):

No description available.

class google.cloud.compute_v1.types.ScalingScheduleStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

last_start_time

[Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format.

This field is a member of oneof _last_start_time.

Type

str

next_start_time

[Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format.

This field is a member of oneof _next_start_time.

Type

str

state

[Output Only] The current state of a scaling schedule. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class State(value)

Bases: proto.enums.Enum

[Output Only] The current state of a scaling schedule.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

The current autoscaling recommendation is influenced by this scaling schedule.

DISABLED (516696700):

This scaling schedule has been disabled by the user.

OBSOLETE (66532761):

This scaling schedule will never become active again.

READY (77848963):

The current autoscaling recommendation is not influenced by this scaling schedule.

class google.cloud.compute_v1.types.Scheduling(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Sets the scheduling options for an Instance.

automatic_restart

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

This field is a member of oneof _automatic_restart.

Type

bool

availability_domain

Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

This field is a member of oneof _availability_domain.

Type

int

instance_termination_action

Specifies the termination action for the instance. Check the InstanceTerminationAction enum for the list of possible values.

This field is a member of oneof _instance_termination_action.

Type

str

local_ssd_recovery_timeout

Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.

This field is a member of oneof _local_ssd_recovery_timeout.

Type

google.cloud.compute_v1.types.Duration

location_hint

An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

This field is a member of oneof _location_hint.

Type

str

max_run_duration

Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration.

This field is a member of oneof _max_run_duration.

Type

google.cloud.compute_v1.types.Duration

min_node_cpus

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

This field is a member of oneof _min_node_cpus.

Type

int

node_affinities

A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

Type

MutableSequence[google.cloud.compute_v1.types.SchedulingNodeAffinity]

on_host_maintenance

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy. Check the OnHostMaintenance enum for the list of possible values.

This field is a member of oneof _on_host_maintenance.

Type

str

on_instance_stop_action

This field is a member of oneof _on_instance_stop_action.

Type

google.cloud.compute_v1.types.SchedulingOnInstanceStopAction

preemptible

Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states.

This field is a member of oneof _preemptible.

Type

bool

provisioning_model

Specifies the provisioning model of the instance. Check the ProvisioningModel enum for the list of possible values.

This field is a member of oneof _provisioning_model.

Type

str

termination_time

Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.

This field is a member of oneof _termination_time.

Type

str

class InstanceTerminationAction(value)

Bases: proto.enums.Enum

Specifies the termination action for the instance.

Values:

UNDEFINED_INSTANCE_TERMINATION_ACTION (0):

A value indicating that the enum field is not set.

DELETE (402225579):

Delete the VM.

INSTANCE_TERMINATION_ACTION_UNSPECIFIED (92954803):

Default value. This value is unused.

STOP (2555906):

Stop the VM without storing in-memory content. default action.

class OnHostMaintenance(value)

Bases: proto.enums.Enum

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.

Values:

UNDEFINED_ON_HOST_MAINTENANCE (0):

A value indicating that the enum field is not set.

MIGRATE (165699979):

[Default] Allows Compute Engine to automatically migrate instances out of the way of maintenance events.

TERMINATE (527617601):

Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.

class ProvisioningModel(value)

Bases: proto.enums.Enum

Specifies the provisioning model of the instance.

Values:

UNDEFINED_PROVISIONING_MODEL (0):

A value indicating that the enum field is not set.

SPOT (2552066):

Heavily discounted, no guaranteed runtime.

STANDARD (484642493):

Standard provisioning with user controlled runtime, no discounts.

class google.cloud.compute_v1.types.SchedulingNodeAffinity(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

key

Corresponds to the label key of Node resource.

This field is a member of oneof _key.

Type

str

operator

Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. Check the Operator enum for the list of possible values.

This field is a member of oneof _operator.

Type

str

values

Corresponds to the label values of Node resource.

Type

MutableSequence[str]

class Operator(value)

Bases: proto.enums.Enum

Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

Values:

UNDEFINED_OPERATOR (0):

A value indicating that the enum field is not set.

IN (2341):

Requires Compute Engine to seek for matched nodes.

NOT_IN (161144369):

Requires Compute Engine to avoid certain nodes.

OPERATOR_UNSPECIFIED (128892924):

No description available.

class google.cloud.compute_v1.types.SchedulingOnInstanceStopAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines the behaviour for instances with the instance_termination_action STOP.

discard_local_ssd

If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time.

This field is a member of oneof _discard_local_ssd.

Type

bool

class google.cloud.compute_v1.types.ScratchDisks(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

disk_gb

Size of the scratch disk, defined in GB.

This field is a member of oneof _disk_gb.

Type

int

class google.cloud.compute_v1.types.Screenshot(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An instance’s screenshot.

contents

[Output Only] The Base64-encoded screenshot data.

This field is a member of oneof _contents.

Type

str

kind

[Output Only] Type of the resource. Always compute#screenshot for the screenshots.

This field is a member of oneof _kind.

Type

str

class google.cloud.compute_v1.types.SecurityPoliciesAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

etag

This field is a member of oneof _etag.

Type

str

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of SecurityPoliciesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.SecurityPoliciesScopedList]

kind

[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.SecurityPoliciesListPreconfiguredExpressionSetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

preconfigured_expression_sets

This field is a member of oneof _preconfigured_expression_sets.

Type

google.cloud.compute_v1.types.SecurityPoliciesWafConfig

class google.cloud.compute_v1.types.SecurityPoliciesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

security_policies

A list of SecurityPolicies contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicy]

warning

Informational warning which replaces the list of security policies when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SecurityPoliciesWafConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

waf_rules

This field is a member of oneof _waf_rules.

Type

google.cloud.compute_v1.types.PreconfiguredWafSet

class google.cloud.compute_v1.types.SecurityPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.

adaptive_protection_config

This field is a member of oneof _adaptive_protection_config.

Type

google.cloud.compute_v1.types.SecurityPolicyAdaptiveProtectionConfig

advanced_options_config

This field is a member of oneof _advanced_options_config.

Type

google.cloud.compute_v1.types.SecurityPolicyAdvancedOptionsConfig

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

ddos_protection_config

This field is a member of oneof _ddos_protection_config.

Type

google.cloud.compute_v1.types.SecurityPolicyDdosProtectionConfig

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

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. To see the latest fingerprint, make get() request to the security policy.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Type

MutableMapping[str, str]

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.

This field is a member of oneof _name.

Type

str

recaptcha_options_config

This field is a member of oneof _recaptcha_options_config.

Type

google.cloud.compute_v1.types.SecurityPolicyRecaptchaOptionsConfig

region

[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.

This field is a member of oneof _region.

Type

str

rules

A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match “*” for srcIpRanges and for the networkMatch condition every field must be either match “*” or not set). If no rules are provided when creating a security policy, a default rule with action “allow” will be added.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRule]

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

type_

The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google’s cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

user_defined_fields

Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: “ipv4_fragment_offset” base: IPV4 offset: 6 size: 2 mask: “0x1fff”.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyUserDefinedField]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Type(value)

Bases: proto.enums.Enum

The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google’s cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

CLOUD_ARMOR (260640373):

No description available.

CLOUD_ARMOR_EDGE (250728775):

No description available.

CLOUD_ARMOR_NETWORK (488527428):

No description available.

class google.cloud.compute_v1.types.SecurityPolicyAdaptiveProtectionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration options for Cloud Armor Adaptive Protection (CAAP).

layer7_ddos_defense_config

If set to true, enables Cloud Armor Machine Learning.

This field is a member of oneof _layer7_ddos_defense_config.

Type

google.cloud.compute_v1.types.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig

class google.cloud.compute_v1.types.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

enable

If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

This field is a member of oneof _enable.

Type

bool

rule_visibility

Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR. Check the RuleVisibility enum for the list of possible values.

This field is a member of oneof _rule_visibility.

Type

str

threshold_configs

Configuration options for layer7 adaptive protection for various customizable thresholds.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig]

class RuleVisibility(value)

Bases: proto.enums.Enum

Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

Values:

UNDEFINED_RULE_VISIBILITY (0):

A value indicating that the enum field is not set.

PREMIUM (399530551):

No description available.

STANDARD (484642493):

No description available.

class google.cloud.compute_v1.types.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

auto_deploy_confidence_threshold

This field is a member of oneof _auto_deploy_confidence_threshold.

Type

float

auto_deploy_expiration_sec

This field is a member of oneof _auto_deploy_expiration_sec.

Type

int

auto_deploy_impacted_baseline_threshold

This field is a member of oneof _auto_deploy_impacted_baseline_threshold.

Type

float

auto_deploy_load_threshold

This field is a member of oneof _auto_deploy_load_threshold.

Type

float

detection_absolute_qps

This field is a member of oneof _detection_absolute_qps.

Type

float

detection_load_threshold

This field is a member of oneof _detection_load_threshold.

Type

float

detection_relative_to_baseline_qps

This field is a member of oneof _detection_relative_to_baseline_qps.

Type

float

name

The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.

This field is a member of oneof _name.

Type

str

traffic_granularity_configs

Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig]

class google.cloud.compute_v1.types.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configurations to specifc granular traffic units processed by Adaptive Protection.

enable_each_unique_value

If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if value is empty.

This field is a member of oneof _enable_each_unique_value.

Type

bool

type_

Type of this configuration. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

value

Requests that match this value constitute a granular traffic unit.

This field is a member of oneof _value.

Type

str

class Type(value)

Bases: proto.enums.Enum

Type of this configuration.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

HTTP_HEADER_HOST (374321891):

No description available.

HTTP_PATH (311503228):

No description available.

UNSPECIFIED_TYPE (53933922):

No description available.

class google.cloud.compute_v1.types.SecurityPolicyAdvancedOptionsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

json_custom_config

Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.

This field is a member of oneof _json_custom_config.

Type

google.cloud.compute_v1.types.SecurityPolicyAdvancedOptionsConfigJsonCustomConfig

json_parsing

Check the JsonParsing enum for the list of possible values.

This field is a member of oneof _json_parsing.

Type

str

log_level

Check the LogLevel enum for the list of possible values.

This field is a member of oneof _log_level.

Type

str

user_ip_request_headers

An optional list of case-insensitive request header names to use for resolving the callers client IP address.

Type

MutableSequence[str]

class JsonParsing(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_JSON_PARSING (0):

A value indicating that the enum field is not set.

DISABLED (516696700):

No description available.

STANDARD (484642493):

No description available.

STANDARD_WITH_GRAPHQL (106979218):

No description available.

class LogLevel(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_LOG_LEVEL (0):

A value indicating that the enum field is not set.

NORMAL (161067239):

No description available.

VERBOSE (532219234):

No description available.

class google.cloud.compute_v1.types.SecurityPolicyAdvancedOptionsConfigJsonCustomConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

content_types

A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type “/” subtype *[“;” parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.SecurityPolicyDdosProtectionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ddos_protection

Check the DdosProtection enum for the list of possible values.

This field is a member of oneof _ddos_protection.

Type

str

class DdosProtection(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_DDOS_PROTECTION (0):

A value indicating that the enum field is not set.

ADVANCED (63789090):

No description available.

STANDARD (484642493):

No description available.

class google.cloud.compute_v1.types.SecurityPolicyList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of SecurityPolicy resources.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicy]

kind

[Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SecurityPolicyRecaptchaOptionsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

redirect_site_key

An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

This field is a member of oneof _redirect_site_key.

Type

str

class google.cloud.compute_v1.types.SecurityPolicyReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

security_policy

This field is a member of oneof _security_policy.

Type

str

class google.cloud.compute_v1.types.SecurityPolicyRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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).

action

The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.

This field is a member of oneof _action.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

header_action

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

This field is a member of oneof _header_action.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleHttpHeaderAction

kind

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

This field is a member of oneof _kind.

Type

str

match

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ‘action’ is enforced.

This field is a member of oneof _match.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleMatcher

network_match

A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding ‘action’ is enforced. The match criteria for a rule consists of built-in match fields (like ‘srcIpRanges’) and potentially multiple user-defined match fields (‘userDefinedFields’). Field values may be extracted directly from the packet or derived from it (e.g. ‘srcRegionCodes’). Some fields may not be present in every packet (e.g. ‘srcPorts’). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it’s not required to be present. For strings specifying ‘*’ is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - “192.0.2.0/24” - “198.51.100.0/24” userDefinedFields: - name: “ipv4_fragment_offset” values: - “1-0x1fff” The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named “ipv4_fragment_offset” with a value between 1 and 0x1fff inclusive.

This field is a member of oneof _network_match.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleNetworkMatcher

preconfigured_waf_config

Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.

This field is a member of oneof _preconfigured_waf_config.

Type

google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfig

preview

If set to true, the specified action is not enforced.

This field is a member of oneof _preview.

Type

bool

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 priority.

This field is a member of oneof _priority.

Type

int

rate_limit_options

Must be specified if the action is “rate_based_ban” or “throttle”. Cannot be specified for any other actions.

This field is a member of oneof _rate_limit_options.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptions

redirect_options

Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

This field is a member of oneof _redirect_options.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleRedirectOptions

class google.cloud.compute_v1.types.SecurityPolicyRuleHttpHeaderAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

request_headers_to_adds

The list of request headers to add or overwrite if they’re already present.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRuleHttpHeaderActionHttpHeaderOption]

class google.cloud.compute_v1.types.SecurityPolicyRuleHttpHeaderActionHttpHeaderOption(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

header_name

The name of the header to set.

This field is a member of oneof _header_name.

Type

str

header_value

The value to set the named header to.

This field is a member of oneof _header_value.

Type

str

class google.cloud.compute_v1.types.SecurityPolicyRuleMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.

config

The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.

This field is a member of oneof _config.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleMatcherConfig

expr

User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing evaluateThreatIntelligence require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing evaluatePreconfiguredExpr('sourceiplist-*') require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.

This field is a member of oneof _expr.

Type

google.cloud.compute_v1.types.Expr

expr_options

The configuration options available when specifying a user defined CEVAL expression (i.e., ‘expr’).

This field is a member of oneof _expr_options.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleMatcherExprOptions

versioned_expr

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. Check the VersionedExpr enum for the list of possible values.

This field is a member of oneof _versioned_expr.

Type

str

class VersionedExpr(value)

Bases: proto.enums.Enum

Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.

Values:

UNDEFINED_VERSIONED_EXPR (0):

A value indicating that the enum field is not set.

SRC_IPS_V1 (70925961):

Matches the source IP address of a request to the IP ranges supplied in config.

class google.cloud.compute_v1.types.SecurityPolicyRuleMatcherConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

src_ip_ranges

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.SecurityPolicyRuleMatcherExprOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

recaptcha_options

reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.

This field is a member of oneof _recaptcha_options.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions

class google.cloud.compute_v1.types.SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

action_token_site_keys

A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.

Type

MutableSequence[str]

session_token_site_keys

A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.SecurityPolicyRuleNetworkMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a match condition that incoming network traffic is evaluated against.

dest_ip_ranges

Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.

Type

MutableSequence[str]

dest_ports

Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. “80”) or range (e.g. “0-1023”).

Type

MutableSequence[str]

ip_protocols

IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. “6”), range (e.g. “253-254”), or one of the following protocol names: “tcp”, “udp”, “icmp”, “esp”, “ah”, “ipip”, or “sctp”.

Type

MutableSequence[str]

src_asns

BGP Autonomous System Number associated with the source IP address.

Type

MutableSequence[int]

src_ip_ranges

Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.

Type

MutableSequence[str]

src_ports

Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. “80”) or range (e.g. “0-1023”).

Type

MutableSequence[str]

src_region_codes

Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.

Type

MutableSequence[str]

user_defined_fields

User-defined fields. Each element names a defined field and lists the matching values for that field.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch]

class google.cloud.compute_v1.types.SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

name

Name of the user-defined field, as given in the definition.

This field is a member of oneof _name.

Type

str

values

Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with “0x”) number (e.g. “64”) or range (e.g. “0x400-0x7ff”).

Type

MutableSequence[str]

class google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

exclusions

A list of exclusions to apply during preconfigured WAF evaluation.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfigExclusion]

class google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfigExclusion(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

request_cookies_to_exclude

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams]

request_headers_to_exclude

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams]

request_query_params_to_exclude

A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams]

request_uris_to_exclude

A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams]

target_rule_ids

A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.

Type

MutableSequence[str]

target_rule_set

Target WAF rule set to apply the preconfigured WAF exclusion.

This field is a member of oneof _target_rule_set.

Type

str

class google.cloud.compute_v1.types.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

op

The match operator for the field. Check the Op enum for the list of possible values.

This field is a member of oneof _op.

Type

str

val

The value of the field.

This field is a member of oneof _val.

Type

str

class Op(value)

Bases: proto.enums.Enum

The match operator for the field.

Values:

UNDEFINED_OP (0):

A value indicating that the enum field is not set.

CONTAINS (215180831):

The operator matches if the field value contains the specified value.

ENDS_WITH (490402221):

The operator matches if the field value ends with the specified value.

EQUALS (442201023):

The operator matches if the field value equals the specified value.

EQUALS_ANY (337226060):

The operator matches if the field value is any value.

STARTS_WITH (139505652):

The operator matches if the field value starts with the specified value.

class google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ban_duration_sec

Can only be specified if the action for the rule is “rate_based_ban”. If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

This field is a member of oneof _ban_duration_sec.

Type

int

ban_threshold

Can only be specified if the action for the rule is “rate_based_ban”. If specified, the key will be banned for the configured ‘ban_duration_sec’ when the number of requests that exceed the ‘rate_limit_threshold’ also exceed this ‘ban_threshold’.

This field is a member of oneof _ban_threshold.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptionsThreshold

conform_action

Action to take for requests that are under the configured rate limit threshold. Valid option is “allow” only.

This field is a member of oneof _conform_action.

Type

str

enforce_on_key

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if “enforceOnKey” is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on “userIpRequestHeaders” configured with the security policy. If there is no “userIpRequestHeaders” configuration or an IP address cannot be resolved from it, the key type defaults to IP. Check the EnforceOnKey enum for the list of possible values.

This field is a member of oneof _enforce_on_key.

Type

str

enforce_on_key_configs

If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.

Type

MutableSequence[google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig]

enforce_on_key_name

Rate limit key name applicable only for the following key types: HTTP_HEADER – Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE – Name of the HTTP cookie whose value is taken as the key value.

This field is a member of oneof _enforce_on_key_name.

Type

str

exceed_action

Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502, and redirect, where the redirect parameters come from exceedRedirectOptions below. The redirect action is only supported in Global Security Policies of type CLOUD_ARMOR.

This field is a member of oneof _exceed_action.

Type

str

exceed_redirect_options

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

This field is a member of oneof _exceed_redirect_options.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleRedirectOptions

rate_limit_threshold

Threshold at which to begin ratelimiting.

This field is a member of oneof _rate_limit_threshold.

Type

google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptionsThreshold

class EnforceOnKey(value)

Bases: proto.enums.Enum

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if “enforceOnKey” is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on “userIpRequestHeaders” configured with the security policy. If there is no “userIpRequestHeaders” configuration or an IP address cannot be resolved from it, the key type defaults to IP.

Values:

UNDEFINED_ENFORCE_ON_KEY (0):

A value indicating that the enum field is not set.

ALL (64897):

No description available.

HTTP_COOKIE (494981627):

No description available.

HTTP_HEADER (91597348):

No description available.

HTTP_PATH (311503228):

No description available.

IP (2343):

No description available.

REGION_CODE (79559768):

No description available.

SNI (82254):

No description available.

TLS_JA3_FINGERPRINT (327127933):

No description available.

USER_IP (34009627):

No description available.

XFF_IP (438707118):

No description available.

class google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

enforce_on_key_name

Rate limit key name applicable only for the following key types: HTTP_HEADER – Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE – Name of the HTTP cookie whose value is taken as the key value.

This field is a member of oneof _enforce_on_key_name.

Type

str

enforce_on_key_type

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if “enforceOnKeyConfigs” is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on “userIpRequestHeaders” configured with the security policy. If there is no “userIpRequestHeaders” configuration or an IP address cannot be resolved from it, the key type defaults to IP. Check the EnforceOnKeyType enum for the list of possible values.

This field is a member of oneof _enforce_on_key_type.

Type

str

class EnforceOnKeyType(value)

Bases: proto.enums.Enum

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if “enforceOnKeyConfigs” is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on “userIpRequestHeaders” configured with the security policy. If there is no “userIpRequestHeaders” configuration or an IP address cannot be resolved from it, the key type defaults to IP.

Values:

UNDEFINED_ENFORCE_ON_KEY_TYPE (0):

A value indicating that the enum field is not set.

ALL (64897):

No description available.

HTTP_COOKIE (494981627):

No description available.

HTTP_HEADER (91597348):

No description available.

HTTP_PATH (311503228):

No description available.

IP (2343):

No description available.

REGION_CODE (79559768):

No description available.

SNI (82254):

No description available.

TLS_JA3_FINGERPRINT (327127933):

No description available.

USER_IP (34009627):

No description available.

XFF_IP (438707118):

No description available.

class google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptionsThreshold(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

count

Number of HTTP(S) requests for calculating the threshold.

This field is a member of oneof _count.

Type

int

interval_sec

Interval over which the threshold is computed.

This field is a member of oneof _interval_sec.

Type

int

class google.cloud.compute_v1.types.SecurityPolicyRuleRedirectOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

This field is a member of oneof _target.

Type

str

type_

Type of the redirect action. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

Type of the redirect action.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

EXTERNAL_302 (395733761):

No description available.

GOOGLE_RECAPTCHA (518803009):

No description available.

class google.cloud.compute_v1.types.SecurityPolicyUserDefinedField(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

base

The base relative to which ‘offset’ is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required Check the Base enum for the list of possible values.

This field is a member of oneof _base.

Type

str

mask

If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with “0x”). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.

This field is a member of oneof _mask.

Type

str

name

The name of this field. Must be unique within the policy.

This field is a member of oneof _name.

Type

str

offset

Offset of the first byte of the field (in network byte order) relative to ‘base’.

This field is a member of oneof _offset.

Type

int

size

Size of the field in bytes. Valid values: 1-4.

This field is a member of oneof _size.

Type

int

class Base(value)

Bases: proto.enums.Enum

The base relative to which ‘offset’ is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required

Values:

UNDEFINED_BASE (0):

A value indicating that the enum field is not set.

IPV4 (2254341):

No description available.

IPV6 (2254343):

No description available.

TCP (82881):

No description available.

UDP (83873):

No description available.

class google.cloud.compute_v1.types.SecuritySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The authentication and authorization settings for a BackendService.

aws_v4_authentication

The configuration needed to generate a signature for access to private storage buckets that support AWS’s Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.

This field is a member of oneof _aws_v4_authentication.

Type

google.cloud.compute_v1.types.AWSV4Signature

client_tls_policy

Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service’s backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.

This field is a member of oneof _client_tls_policy.

Type

str

subject_alt_names

Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate’s subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate’s subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).

Type

MutableSequence[str]

class google.cloud.compute_v1.types.SendDiagnosticInterruptInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SendDiagnosticInterrupt. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SendDiagnosticInterruptInstanceResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A response message for Instances.SendDiagnosticInterrupt. See the method description for details.

class google.cloud.compute_v1.types.SerialPortOutput(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An instance serial console output.

contents

[Output Only] The contents of the console output.

This field is a member of oneof _contents.

Type

str

kind

[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

This field is a member of oneof _kind.

Type

str

next_

[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the contents property. Use this value in the next request as the start parameter.

This field is a member of oneof _next.

Type

int

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

start

The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the start value that was specified in the request.

This field is a member of oneof _start.

Type

int

class google.cloud.compute_v1.types.ServerBinding(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

type_

Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

RESTART_NODE_ON_ANY_SERVER (502950985):

Node may associate with any physical server over its lifetime.

RESTART_NODE_ON_MINIMAL_SERVERS (204166495):

Node may associate with minimal physical servers over its lifetime.

SERVER_BINDING_TYPE_UNSPECIFIED (180825512):

No description available.

class google.cloud.compute_v1.types.ServiceAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A service account.

email

Email address of the service account.

This field is a member of oneof _email.

Type

str

scopes

The list of scopes to be made available for this service account.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.ServiceAttachment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a ServiceAttachment resource. A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service.

connected_endpoints

[Output Only] An array of connections for all the consumers connected to this service attachment.

Type

MutableSequence[google.cloud.compute_v1.types.ServiceAttachmentConnectedEndpoint]

connection_preference

The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules. Check the ConnectionPreference enum for the list of possible values.

This field is a member of oneof _connection_preference.

Type

str

consumer_accept_lists

Specifies which consumer projects or networks are allowed to connect to the service attachment. Each project or network has a connection limit. A given service attachment can manage connections at either the project or network level. Therefore, both the accept and reject lists for a given service attachment must contain either only projects or only networks.

Type

MutableSequence[google.cloud.compute_v1.types.ServiceAttachmentConsumerProjectLimit]

consumer_reject_lists

Specifies a list of projects or networks that are not allowed to connect to this service attachment. The project can be specified using its project ID or project number and the network can be specified using its URL. A given service attachment can manage connections at either the project or network level. Therefore, both the reject and accept lists for a given service attachment must contain either only projects or only networks.

Type

MutableSequence[str]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

domain_names

If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: “p.mycompany.com.”. Current max number of domain names supported is 1.

Type

MutableSequence[str]

enable_proxy_protocol

If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

This field is a member of oneof _enable_proxy_protocol.

Type

bool

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 ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource type. The server generates this identifier.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

nat_subnets

An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

Type

MutableSequence[str]

producer_forwarding_rule

The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

This field is a member of oneof _producer_forwarding_rule.

Type

str

propagated_connection_limit

The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250.

This field is a member of oneof _propagated_connection_limit.

Type

int

psc_service_attachment_id

[Output Only] An 128-bit global unique ID of the PSC service attachment.

This field is a member of oneof _psc_service_attachment_id.

Type

google.cloud.compute_v1.types.Uint128

reconcile_connections

This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.

This field is a member of oneof _reconcile_connections.

Type

bool

region

[Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

target_service

The URL of a service serving the endpoint identified by this service attachment.

This field is a member of oneof _target_service.

Type

str

class ConnectionPreference(value)

Bases: proto.enums.Enum

The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.

Values:

UNDEFINED_CONNECTION_PREFERENCE (0):

A value indicating that the enum field is not set.

ACCEPT_AUTOMATIC (75250580):

No description available.

ACCEPT_MANUAL (373061341):

No description available.

CONNECTION_PREFERENCE_UNSPECIFIED (34590772):

No description available.

class google.cloud.compute_v1.types.ServiceAttachmentAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of ServiceAttachmentsScopedList.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of ServiceAttachmentsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.ServiceAttachmentsScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.ServiceAttachmentConnectedEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] A connection connected to this service attachment.

consumer_network

The url of the consumer network.

This field is a member of oneof _consumer_network.

Type

str

endpoint

The url of a connected endpoint.

This field is a member of oneof _endpoint.

Type

str

propagated_connection_count

The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to.

This field is a member of oneof _propagated_connection_count.

Type

int

psc_connection_id

The PSC connection id of the connected endpoint.

This field is a member of oneof _psc_connection_id.

Type

int

status

The status of a connected endpoint to this service attachment. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class Status(value)

Bases: proto.enums.Enum

The status of a connected endpoint to this service attachment.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ACCEPTED (246714279):

The connection has been accepted by the producer.

CLOSED (380163436):

The connection has been closed by the producer.

NEEDS_ATTENTION (344491452):

The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.

PENDING (35394935):

The connection is pending acceptance by the producer.

REJECTED (174130302):

The consumer is still connected but not using the connection.

STATUS_UNSPECIFIED (42133066):

No description available.

class google.cloud.compute_v1.types.ServiceAttachmentConsumerProjectLimit(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

connection_limit

The value of the limit to set.

This field is a member of oneof _connection_limit.

Type

int

network_url

The network URL for the network to set the limit for.

This field is a member of oneof _network_url.

Type

str

project_id_or_num

The project id or number for the project to set the limit for.

This field is a member of oneof _project_id_or_num.

Type

str

class google.cloud.compute_v1.types.ServiceAttachmentList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of ServiceAttachment resources.

Type

MutableSequence[google.cloud.compute_v1.types.ServiceAttachment]

kind

[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ServiceAttachmentsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

service_attachments

A list of ServiceAttachments contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.ServiceAttachment]

warning

Informational warning which replaces the list of service attachments when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SetBackendServiceTargetSslProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.SetBackendService. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_ssl_proxies_set_backend_service_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetSslProxiesSetBackendServiceRequest

target_ssl_proxy

Name of the TargetSslProxy resource whose BackendService resource is to be set.

Type

str

class google.cloud.compute_v1.types.SetBackendServiceTargetTcpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetTcpProxies.SetBackendService. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_tcp_proxies_set_backend_service_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetTcpProxiesSetBackendServiceRequest

target_tcp_proxy

Name of the TargetTcpProxy resource whose BackendService resource is to be set.

Type

str

class google.cloud.compute_v1.types.SetBackupTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.SetBackup. See the method description for details.

failover_ratio

New failoverRatio value for the target pool.

This field is a member of oneof _failover_ratio.

Type

float

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_pool

Name of the TargetPool resource to set a backup pool for.

Type

str

target_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetReference

class google.cloud.compute_v1.types.SetCertificateMapTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.SetCertificateMap. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxies_set_certificate_map_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpsProxiesSetCertificateMapRequest

target_https_proxy

Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.

Type

str

class google.cloud.compute_v1.types.SetCertificateMapTargetSslProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.SetCertificateMap. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_ssl_proxies_set_certificate_map_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetSslProxiesSetCertificateMapRequest

target_ssl_proxy

Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.

Type

str

class google.cloud.compute_v1.types.SetCloudArmorTierProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.SetCloudArmorTier. See the method description for details.

project

Project ID for this request.

Type

str

projects_set_cloud_armor_tier_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ProjectsSetCloudArmorTierRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.SetCommonInstanceMetadataOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

client_operation_id

[Output Only] The client operation id.

This field is a member of oneof _client_operation_id.

Type

str

per_location_operations

[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a

Type

MutableMapping[str, google.cloud.compute_v1.types.SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo]

class PerLocationOperationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

error

[Output Only] If state is ABANDONED or FAILED, this field is populated.

This field is a member of oneof _error.

Type

google.cloud.compute_v1.types.Status

state

[Output Only] Status of the action, which can be one of the following: PROPAGATING, PROPAGATED, ABANDONED, FAILED, or DONE. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class State(value)

Bases: proto.enums.Enum

[Output Only] Status of the action, which can be one of the following: PROPAGATING, PROPAGATED, ABANDONED, FAILED, or DONE.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

ABANDONED (81797556):

Operation not tracked in this location e.g. zone is marked as DOWN.

DONE (2104194):

Operation has completed successfully.

FAILED (455706685):

Operation is in an error state.

PROPAGATED (507550299):

Operation is confirmed to be in the location.

PROPAGATING (164807046):

Operation is not yet confirmed to have been created in the location.

UNSPECIFIED (526786327):

No description available.

class google.cloud.compute_v1.types.SetCommonInstanceMetadataProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.SetCommonInstanceMetadata. See the method description for details.

metadata_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Metadata

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.SetDefaultNetworkTierProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.SetDefaultNetworkTier. See the method description for details.

project

Project ID for this request.

Type

str

projects_set_default_network_tier_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ProjectsSetDefaultNetworkTierRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.SetDeletionProtectionInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetDeletionProtection. See the method description for details.

deletion_protection

Whether the resource should be protected against deletion.

This field is a member of oneof _deletion_protection.

Type

bool

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetDiskAutoDeleteInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetDiskAutoDelete. See the method description for details.

auto_delete

Whether to auto-delete the disk when the instance is deleted.

Type

bool

device_name

The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.

Type

str

instance

The instance name for this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetEdgeSecurityPolicyBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.SetEdgeSecurityPolicy. See the method description for details.

backend_bucket

Name of the BackendBucket resource to which the security policy should be set. The name should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyReference

class google.cloud.compute_v1.types.SetEdgeSecurityPolicyBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.SetEdgeSecurityPolicy. See the method description for details.

backend_service

Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyReference

class google.cloud.compute_v1.types.SetIamPolicyBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.SetIamPolicy. See the method description for details.

global_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetPolicyRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.SetIamPolicy. See the method description for details.

global_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetPolicyRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

zone_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ZoneSetPolicyRequest

class google.cloud.compute_v1.types.SetIamPolicyFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.SetIamPolicy. See the method description for details.

global_organization_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalOrganizationSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.SetIamPolicy. See the method description for details.

global_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetPolicyRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

zone_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ZoneSetPolicyRequest

class google.cloud.compute_v1.types.SetIamPolicyInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceTemplates.SetIamPolicy. See the method description for details.

global_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetPolicyRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

zone_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ZoneSetPolicyRequest

class google.cloud.compute_v1.types.SetIamPolicyLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Licenses.SetIamPolicy. See the method description for details.

global_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetPolicyRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyMachineImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineImages.SetIamPolicy. See the method description for details.

global_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetPolicyRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyNetworkAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.SetIamPolicy. See the method description for details.

global_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetPolicyRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

zone_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ZoneSetPolicyRequest

class google.cloud.compute_v1.types.SetIamPolicyNodeTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTemplates.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyRegionInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstantSnapshots.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

zone_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ZoneSetPolicyRequest

class google.cloud.compute_v1.types.SetIamPolicyResourcePolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyServiceAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicySnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Snapshots.SetIamPolicy. See the method description for details.

global_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetPolicyRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetIamPolicyStoragePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

zone_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ZoneSetPolicyRequest

class google.cloud.compute_v1.types.SetIamPolicySubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.SetIamPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_set_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetPolicyRequest

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetInstanceTemplateInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.SetInstanceTemplate. See the method description for details.

instance_group_manager

The name of the managed instance group.

Type

str

instance_group_managers_set_instance_template_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersSetInstanceTemplateRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the managed instance group is located.

Type

str

class google.cloud.compute_v1.types.SetInstanceTemplateRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.SetInstanceTemplate. See the method description for details.

instance_group_manager

The name of the managed instance group.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_instance_group_managers_set_template_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagersSetTemplateRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.SetLabelsAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Addresses.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

region

The region for this request.

Type

str

region_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetLabelsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

zone_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ZoneSetLabelsRequest

class google.cloud.compute_v1.types.SetLabelsExternalVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ExternalVpnGateways.SetLabels. See the method description for details.

global_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetLabelsRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ForwardingRules.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

region

The region for this request.

Type

str

region_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetLabelsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsGlobalAddressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalAddresses.SetLabels. See the method description for details.

global_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetLabelsRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsGlobalForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalForwardingRules.SetLabels. See the method description for details.

global_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetLabelsRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.SetLabels. See the method description for details.

global_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetLabelsRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetLabels. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

instances_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesSetLabelsRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

zone

The name of the zone for this request.

Type

str

zone_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ZoneSetLabelsRequest

class google.cloud.compute_v1.types.SetLabelsInterconnectAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InterconnectAttachments.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

region

The region for this request.

Type

str

region_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetLabelsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsInterconnectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Interconnects.SetLabels. See the method description for details.

global_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetLabelsRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

region

The region for this request.

Type

str

region_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetLabelsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsRegionInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstantSnapshots.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

region

The region for this request.

Type

str

region_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetLabelsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsSecurityPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for SecurityPolicies.SetLabels. See the method description for details.

global_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetLabelsRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Snapshots.SetLabels. See the method description for details.

global_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.GlobalSetLabelsRequest

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsTargetVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetVpnGateways.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

region

The region for this request.

Type

str

region_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetLabelsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnGateways.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

region

The region for this request.

Type

str

region_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetLabelsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetLabelsVpnTunnelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnTunnels.SetLabels. See the method description for details.

project

Project ID for this request.

Type

str

region

The region for this request.

Type

str

region_set_labels_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionSetLabelsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

resource

Name or id of the resource for this request.

Type

str

class google.cloud.compute_v1.types.SetMachineResourcesInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetMachineResources. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

instances_set_machine_resources_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesSetMachineResourcesRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetMachineTypeInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetMachineType. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

instances_set_machine_type_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesSetMachineTypeRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetMetadataInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetMetadata. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

metadata_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Metadata

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetMinCpuPlatformInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetMinCpuPlatform. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

instances_set_min_cpu_platform_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesSetMinCpuPlatformRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetNameInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetName. See the method description for details.

instance

The instance name for this request.

Type

str

instances_set_name_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesSetNameRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetNamedPortsInstanceGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroups.SetNamedPorts. See the method description for details.

instance_group

The name of the instance group where the named ports are updated.

Type

str

instance_groups_set_named_ports_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupsSetNamedPortsRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the instance group is located.

Type

str

class google.cloud.compute_v1.types.SetNamedPortsRegionInstanceGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroups.SetNamedPorts. See the method description for details.

instance_group

The name of the regional instance group where the named ports are updated.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_instance_groups_set_named_ports_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupsSetNamedPortsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.SetNodeTemplateNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.SetNodeTemplate. See the method description for details.

node_group

Name of the NodeGroup resource to update.

Type

str

node_groups_set_node_template_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NodeGroupsSetNodeTemplateRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetPrivateIpGoogleAccessSubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.SetPrivateIpGoogleAccess. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

subnetwork

Name of the Subnetwork resource.

Type

str

subnetworks_set_private_ip_google_access_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SubnetworksSetPrivateIpGoogleAccessRequest

class google.cloud.compute_v1.types.SetProxyHeaderTargetSslProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.SetProxyHeader. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_ssl_proxies_set_proxy_header_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetSslProxiesSetProxyHeaderRequest

target_ssl_proxy

Name of the TargetSslProxy resource whose ProxyHeader is to be set.

Type

str

class google.cloud.compute_v1.types.SetProxyHeaderTargetTcpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetTcpProxies.SetProxyHeader. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_tcp_proxies_set_proxy_header_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetTcpProxiesSetProxyHeaderRequest

target_tcp_proxy

Name of the TargetTcpProxy resource whose ProxyHeader is to be set.

Type

str

class google.cloud.compute_v1.types.SetQuicOverrideTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.SetQuicOverride. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxies_set_quic_override_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpsProxiesSetQuicOverrideRequest

target_https_proxy

Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.SetSchedulingInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetScheduling. See the method description for details.

instance

Instance name for this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

scheduling_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Scheduling

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetSecurityPolicyBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.SetSecurityPolicy. See the method description for details.

backend_service

Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyReference

class google.cloud.compute_v1.types.SetSecurityPolicyInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetSecurityPolicy. See the method description for details.

instance

Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035.

Type

str

instances_set_security_policy_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesSetSecurityPolicyRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

Name of the zone scoping this request.

Type

str

class google.cloud.compute_v1.types.SetSecurityPolicyRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.SetSecurityPolicy. See the method description for details.

backend_service

Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyReference

class google.cloud.compute_v1.types.SetSecurityPolicyTargetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetInstances.SetSecurityPolicy. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyReference

target_instance

Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.

Type

str

zone

Name of the zone scoping this request.

Type

str

class google.cloud.compute_v1.types.SetSecurityPolicyTargetPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetPools.SetSecurityPolicy. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

security_policy_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SecurityPolicyReference

target_pool

Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.SetServiceAccountInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetServiceAccount. See the method description for details.

instance

Name of the instance resource to start.

Type

str

instances_set_service_account_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesSetServiceAccountRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetShieldedInstanceIntegrityPolicyInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetShieldedInstanceIntegrityPolicy. See the method description for details.

instance

Name or id of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

shielded_instance_integrity_policy_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ShieldedInstanceIntegrityPolicy

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetSslCertificatesRegionTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpsProxies.SetSslCertificates. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_target_https_proxies_set_ssl_certificates_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionTargetHttpsProxiesSetSslCertificatesRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxy

Name of the TargetHttpsProxy resource to set an SslCertificates resource for.

Type

str

class google.cloud.compute_v1.types.SetSslCertificatesTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.SetSslCertificates. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxies_set_ssl_certificates_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetHttpsProxiesSetSslCertificatesRequest

target_https_proxy

Name of the TargetHttpsProxy resource to set an SslCertificates resource for.

Type

str

class google.cloud.compute_v1.types.SetSslCertificatesTargetSslProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.SetSslCertificates. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_ssl_proxies_set_ssl_certificates_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetSslProxiesSetSslCertificatesRequest

target_ssl_proxy

Name of the TargetSslProxy resource whose SslCertificate resource is to be set.

Type

str

class google.cloud.compute_v1.types.SetSslPolicyTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.SetSslPolicy. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

ssl_policy_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SslPolicyReference

target_https_proxy

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

str

class google.cloud.compute_v1.types.SetSslPolicyTargetSslProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetSslProxies.SetSslPolicy. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

ssl_policy_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.SslPolicyReference

target_ssl_proxy

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

str

class google.cloud.compute_v1.types.SetTagsInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SetTags. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

tags_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Tags

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SetTargetForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ForwardingRules.SetTarget. See the method description for details.

forwarding_rule

Name of the ForwardingRule resource in which target is to be set.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetReference

class google.cloud.compute_v1.types.SetTargetGlobalForwardingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalForwardingRules.SetTarget. See the method description for details.

forwarding_rule

Name of the ForwardingRule resource in which target is to be set.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TargetReference

class google.cloud.compute_v1.types.SetTargetPoolsInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.SetTargetPools. See the method description for details.

instance_group_manager

The name of the managed instance group.

Type

str

instance_group_managers_set_target_pools_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersSetTargetPoolsRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the managed instance group is located.

Type

str

class google.cloud.compute_v1.types.SetTargetPoolsRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.SetTargetPools. See the method description for details.

instance_group_manager

Name of the managed instance group.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_instance_group_managers_set_target_pools_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagersSetTargetPoolsRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.SetUrlMapRegionTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpProxies.SetUrlMap. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_http_proxy

Name of the TargetHttpProxy to set a URL map for.

Type

str

url_map_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMapReference

class google.cloud.compute_v1.types.SetUrlMapRegionTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionTargetHttpsProxies.SetUrlMap. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxy

Name of the TargetHttpsProxy to set a URL map for.

Type

str

url_map_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMapReference

class google.cloud.compute_v1.types.SetUrlMapTargetHttpProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpProxies.SetUrlMap. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_http_proxy

Name of the TargetHttpProxy to set a URL map for.

Type

str

url_map_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMapReference

class google.cloud.compute_v1.types.SetUrlMapTargetHttpsProxyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for TargetHttpsProxies.SetUrlMap. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

target_https_proxy

Name of the TargetHttpsProxy resource whose URL map is to be set.

Type

str

url_map_reference_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMapReference

class google.cloud.compute_v1.types.SetUsageExportBucketProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Projects.SetUsageExportBucket. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

usage_export_location_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UsageExportLocation

class google.cloud.compute_v1.types.ShareSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The share setting for reservations and sole tenancy node groups.

project_map

A map of project id and project config. This is only valid when share_type’s value is SPECIFIC_PROJECTS.

Type

MutableMapping[str, google.cloud.compute_v1.types.ShareSettingsProjectConfig]

share_type

Type of sharing for this shared-reservation Check the ShareType enum for the list of possible values.

This field is a member of oneof _share_type.

Type

str

class ProjectMapEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class ShareType(value)

Bases: proto.enums.Enum

Type of sharing for this shared-reservation

Values:

UNDEFINED_SHARE_TYPE (0):

A value indicating that the enum field is not set.

LOCAL (72607563):

Default value.

ORGANIZATION (274978099):

Shared-reservation is open to entire Organization

SHARE_TYPE_UNSPECIFIED (494771730):

Default value. This value is unused.

SPECIFIC_PROJECTS (347838695):

Shared-reservation is open to specific projects

class google.cloud.compute_v1.types.ShareSettingsProjectConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Config for each project in the share settings.

project_id

The project ID, should be same as the key of this project config in the parent map.

This field is a member of oneof _project_id.

Type

str

class google.cloud.compute_v1.types.ShieldedInstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A set of Shielded Instance options.

enable_integrity_monitoring

Defines whether the instance has integrity monitoring enabled. Enabled by default.

This field is a member of oneof _enable_integrity_monitoring.

Type

bool

enable_secure_boot

Defines whether the instance has Secure Boot enabled. Disabled by default.

This field is a member of oneof _enable_secure_boot.

Type

bool

enable_vtpm

Defines whether the instance has the vTPM enabled. Enabled by default.

This field is a member of oneof _enable_vtpm.

Type

bool

class google.cloud.compute_v1.types.ShieldedInstanceIdentity(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Shielded Instance Identity.

encryption_key

An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance’s vTPM.

This field is a member of oneof _encryption_key.

Type

google.cloud.compute_v1.types.ShieldedInstanceIdentityEntry

kind

[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

This field is a member of oneof _kind.

Type

str

signing_key

An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance’s vTPM.

This field is a member of oneof _signing_key.

Type

google.cloud.compute_v1.types.ShieldedInstanceIdentityEntry

class google.cloud.compute_v1.types.ShieldedInstanceIdentityEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Shielded Instance Identity Entry.

ek_cert

A PEM-encoded X.509 certificate. This field can be empty.

This field is a member of oneof _ek_cert.

Type

str

ek_pub

A PEM-encoded public key.

This field is a member of oneof _ek_pub.

Type

str

class google.cloud.compute_v1.types.ShieldedInstanceIntegrityPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The policy describes the baseline against which Instance boot integrity is measured.

update_auto_learn_policy

Updates the integrity policy baseline using the measurements from the VM instance’s most recent boot.

This field is a member of oneof _update_auto_learn_policy.

Type

bool

class google.cloud.compute_v1.types.SignedUrlKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

key_name

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.

This field is a member of oneof _key_name.

Type

str

key_value

128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.

This field is a member of oneof _key_value.

Type

str

class google.cloud.compute_v1.types.SimulateMaintenanceEventInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.SimulateMaintenanceEvent. See the method description for details.

instance

Name of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

with_extended_notifications

Determines whether the customers receive notifications before migration. Only applicable to SF vms.

This field is a member of oneof _with_extended_notifications.

Type

bool

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SimulateMaintenanceEventNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.SimulateMaintenanceEvent. See the method description for details.

node_group

Name of the NodeGroup resource whose nodes will go under maintenance simulation.

Type

str

node_groups_simulate_maintenance_event_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NodeGroupsSimulateMaintenanceEventRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.Snapshot(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

architecture

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

This field is a member of oneof _architecture.

Type

str

auto_created

[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

This field is a member of oneof _auto_created.

Type

bool

chain_name

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

This field is a member of oneof _chain_name.

Type

str

creation_size_bytes

[Output Only] Size in bytes of the snapshot at creation time.

This field is a member of oneof _creation_size_bytes.

Type

int

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

disk_size_gb

[Output Only] Size of the source disk, specified in GB.

This field is a member of oneof _disk_size_gb.

Type

int

download_bytes

[Output Only] Number of bytes downloaded to restore a snapshot to a disk.

This field is a member of oneof _download_bytes.

Type

int

enable_confidential_compute

Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

This field is a member of oneof _enable_confidential_compute.

Type

bool

guest_os_features

[Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Type

MutableSequence[google.cloud.compute_v1.types.GuestOsFeature]

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

Type

MutableMapping[str, str]

license_codes

[Output Only] Integer license codes indicating which licenses are attached to this snapshot.

Type

MutableSequence[int]

licenses

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

Type

MutableSequence[str]

location_hint

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.

This field is a member of oneof _location_hint.

Type

str

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.

This field is a member of oneof _name.

Type

str

satisfies_pzi

Output only. Reserved for future use.

This field is a member of oneof _satisfies_pzi.

Type

bool

satisfies_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _satisfies_pzs.

Type

bool

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

snapshot_encryption_key

Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.

This field is a member of oneof _snapshot_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

snapshot_type

Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values.

This field is a member of oneof _snapshot_type.

Type

str

source_disk

The source disk used to create this snapshot.

This field is a member of oneof _source_disk.

Type

str

source_disk_encryption_key

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

This field is a member of oneof _source_disk_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_disk_for_recovery_checkpoint

The source disk whose recovery checkpoint will be used to create this snapshot.

This field is a member of oneof _source_disk_for_recovery_checkpoint.

Type

str

source_disk_id

[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.

This field is a member of oneof _source_disk_id.

Type

str

source_instant_snapshot

The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

This field is a member of oneof _source_instant_snapshot.

Type

str

source_instant_snapshot_encryption_key

Customer provided encryption key when creating Snapshot from Instant Snapshot.

This field is a member of oneof _source_instant_snapshot_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_instant_snapshot_id

[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.

This field is a member of oneof _source_instant_snapshot_id.

Type

str

source_snapshot_schedule_policy

[Output Only] URL of the resource policy which created this scheduled snapshot.

This field is a member of oneof _source_snapshot_schedule_policy.

Type

str

source_snapshot_schedule_policy_id

[Output Only] ID of the resource policy which created this scheduled snapshot.

This field is a member of oneof _source_snapshot_schedule_policy_id.

Type

str

status

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

storage_bytes

[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.

This field is a member of oneof _storage_bytes.

Type

int

storage_bytes_status

[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. Check the StorageBytesStatus enum for the list of possible values.

This field is a member of oneof _storage_bytes_status.

Type

str

storage_locations

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

Type

MutableSequence[str]

class Architecture(value)

Bases: proto.enums.Enum

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.

Values:

UNDEFINED_ARCHITECTURE (0):

A value indicating that the enum field is not set.

ARCHITECTURE_UNSPECIFIED (394750507):

Default value indicating Architecture is not set.

ARM64 (62547450):

Machines with architecture ARM64

X86_64 (425300551):

Machines with architecture X86_64

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class SnapshotType(value)

Bases: proto.enums.Enum

Indicates the type of the snapshot.

Values:

UNDEFINED_SNAPSHOT_TYPE (0):

A value indicating that the enum field is not set.

ARCHIVE (506752162):

No description available.

STANDARD (484642493):

No description available.

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

Snapshot creation is in progress.

DELETING (528602024):

Snapshot is currently being deleted.

FAILED (455706685):

Snapshot creation failed.

READY (77848963):

Snapshot has been created successfully.

UPLOADING (267603489):

Snapshot is being uploaded.

class StorageBytesStatus(value)

Bases: proto.enums.Enum

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

Values:

UNDEFINED_STORAGE_BYTES_STATUS (0):

A value indicating that the enum field is not set.

UPDATING (494614342):

No description available.

UP_TO_DATE (101306702):

No description available.

class google.cloud.compute_v1.types.SnapshotList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of Snapshot resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Snapshot resources.

Type

MutableSequence[google.cloud.compute_v1.types.Snapshot]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SnapshotSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

storage_location

Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out.

This field is a member of oneof _storage_location.

Type

google.cloud.compute_v1.types.SnapshotSettingsStorageLocationSettings

class google.cloud.compute_v1.types.SnapshotSettingsStorageLocationSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

locations

When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are Cloud Storage bucket locations. Only one location can be specified.

Type

MutableMapping[str, google.cloud.compute_v1.types.SnapshotSettingsStorageLocationSettingsStorageLocationPreference]

policy

The chosen location policy. Check the Policy enum for the list of possible values.

This field is a member of oneof _policy.

Type

str

class LocationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Policy(value)

Bases: proto.enums.Enum

The chosen location policy.

Values:

UNDEFINED_POLICY (0):

A value indicating that the enum field is not set.

LOCAL_REGION (403535464):

Store snapshot in the same region as with the originating disk. No additional parameters are needed.

NEAREST_MULTI_REGION (212467515):

Store snapshot in the nearest multi region Cloud Storage bucket, relative to the originating disk. No additional parameters are needed.

SPECIFIC_LOCATIONS (280093809):

Store snapshot in the specific locations, as specified by the user. The list of regions to store must be defined under the locations field.

STORAGE_LOCATION_POLICY_UNSPECIFIED (250644592):

No description available.

class google.cloud.compute_v1.types.SnapshotSettingsStorageLocationSettingsStorageLocationPreference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A structure for specifying storage locations.

name

Name of the location. It should be one of the Cloud Storage buckets. Only one location can be specified.

This field is a member of oneof _name.

Type

str

class google.cloud.compute_v1.types.SourceDiskEncryptionKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

disk_encryption_key

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

This field is a member of oneof _disk_encryption_key.

Type

google.cloud.compute_v1.types.CustomerEncryptionKey

source_disk

URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk

This field is a member of oneof _source_disk.

Type

str

class google.cloud.compute_v1.types.SourceInstanceParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A specification of the parameters to use when creating the instance template from a source instance.

disk_configs

Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.

Type

MutableSequence[google.cloud.compute_v1.types.DiskInstantiationConfig]

class google.cloud.compute_v1.types.SourceInstanceProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.

can_ip_forward

Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

This field is a member of oneof _can_ip_forward.

Type

bool

deletion_protection

Whether the instance created from this machine image should be protected against deletion.

This field is a member of oneof _deletion_protection.

Type

bool

description

An optional text description for the instances that are created from this machine image.

This field is a member of oneof _description.

Type

str

disks

An array of disks that are associated with the instances that are created from this machine image.

Type

MutableSequence[google.cloud.compute_v1.types.SavedAttachedDisk]

guest_accelerators

A list of guest accelerator cards’ type and count to use for instances created from this machine image.

Type

MutableSequence[google.cloud.compute_v1.types.AcceleratorConfig]

key_revocation_action_type

KeyRevocationActionType of the instance. Supported options are “STOP” and “NONE”. The default value is “NONE” if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.

This field is a member of oneof _key_revocation_action_type.

Type

str

labels

Labels to apply to instances that are created from this machine image.

Type

MutableMapping[str, str]

machine_type

The machine type to use for instances that are created from this machine image.

This field is a member of oneof _machine_type.

Type

str

metadata

The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

This field is a member of oneof _metadata.

Type

google.cloud.compute_v1.types.Metadata

min_cpu_platform

Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: “Intel Haswell” or minCpuPlatform: “Intel Sandy Bridge”. For more information, read Specifying a Minimum CPU Platform.

This field is a member of oneof _min_cpu_platform.

Type

str

network_interfaces

An array of network access configurations for this interface.

Type

MutableSequence[google.cloud.compute_v1.types.NetworkInterface]

scheduling

Specifies the scheduling options for the instances that are created from this machine image.

This field is a member of oneof _scheduling.

Type

google.cloud.compute_v1.types.Scheduling

service_accounts

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.

Type

MutableSequence[google.cloud.compute_v1.types.ServiceAccount]

tags

A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

This field is a member of oneof _tags.

Type

google.cloud.compute_v1.types.Tags

class KeyRevocationActionType(value)

Bases: proto.enums.Enum

KeyRevocationActionType of the instance. Supported options are “STOP” and “NONE”. The default value is “NONE” if it is not specified.

Values:

UNDEFINED_KEY_REVOCATION_ACTION_TYPE (0):

A value indicating that the enum field is not set.

KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED (467110106):

Default value. This value is unused.

NONE (2402104):

Indicates user chose no operation.

STOP (2555906):

Indicates user chose to opt for VM shutdown on key revocation.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.SslCertificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an SSL certificate resource. Google Compute Engine has two SSL certificate resources: * Global * Regional The global SSL certificates (sslCertificates) are used by: - Global external Application Load Balancers - Classic Application Load Balancers - Proxy Network Load Balancers (with target SSL proxies) The regional SSL certificates (regionSslCertificates) are used by: - Regional external Application Load Balancers - Regional internal Application Load Balancers Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.

certificate

A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

This field is a member of oneof _certificate.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

expire_time

[Output Only] Expire time of the certificate. RFC3339

This field is a member of oneof _expire_time.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

This field is a member of oneof _kind.

Type

str

managed

Configuration and status of a managed SSL certificate.

This field is a member of oneof _managed.

Type

google.cloud.compute_v1.types.SslCertificateManagedSslCertificate

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.

This field is a member of oneof _name.

Type

str

private_key

A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

This field is a member of oneof _private_key.

Type

str

region

[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

This field is a member of oneof _region.

Type

str

self_link

[Output only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

self_managed

Configuration and status of a self-managed SSL certificate.

This field is a member of oneof _self_managed.

Type

google.cloud.compute_v1.types.SslCertificateSelfManagedSslCertificate

subject_alternative_names

[Output Only] Domains associated with the certificate via Subject Alternative Name.

Type

MutableSequence[str]

type_

(Optional) Specifies the type of SSL certificate, either “SELF_MANAGED” or “MANAGED”. If not specified, the certificate is self-managed and the fields certificate and private_key are used. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

(Optional) Specifies the type of SSL certificate, either “SELF_MANAGED” or “MANAGED”. If not specified, the certificate is self-managed and the fields certificate and private_key are used.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

MANAGED (479501183):

Google-managed SSLCertificate.

SELF_MANAGED (434437516):

Certificate uploaded by user.

TYPE_UNSPECIFIED (437714322):

No description available.

class google.cloud.compute_v1.types.SslCertificateAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of SslCertificatesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.SslCertificatesScopedList]

kind

[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.SslCertificateList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of SslCertificate resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of SslCertificate resources.

Type

MutableSequence[google.cloud.compute_v1.types.SslCertificate]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SslCertificateManagedSslCertificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration and status of a managed SSL certificate.

domain_status

[Output only] Detailed statuses of the domains specified for managed certificate resource.

Type

MutableMapping[str, str]

domains

The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the maximum number of domains per Google-managed SSL certificate.

Type

MutableSequence[str]

status

[Output only] Status of the managed certificate resource. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

class DomainStatusEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Status(value)

Bases: proto.enums.Enum

[Output only] Status of the managed certificate resource.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

The certificate management is working, and a certificate has been provisioned.

MANAGED_CERTIFICATE_STATUS_UNSPECIFIED (474800850):

No description available.

PROVISIONING (290896621):

The certificate management is working. GCP will attempt to provision the first certificate.

PROVISIONING_FAILED (76813775):

Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.

PROVISIONING_FAILED_PERMANENTLY (275036203):

Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won’t be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.

RENEWAL_FAILED (434659076):

Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field.

class google.cloud.compute_v1.types.SslCertificateSelfManagedSslCertificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration and status of a self-managed SSL certificate.

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.

This field is a member of oneof _certificate.

Type

str

private_key

A write-only private key in PEM format. Only insert requests will include this field.

This field is a member of oneof _private_key.

Type

str

class google.cloud.compute_v1.types.SslCertificatesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ssl_certificates

List of SslCertificates contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.SslCertificate]

warning

Informational warning which replaces the list of backend services when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SslPoliciesAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

etag

This field is a member of oneof _etag.

Type

str

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of SslPoliciesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.SslPoliciesScopedList]

kind

[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.SslPoliciesList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of SslPolicy resources.

Type

MutableSequence[google.cloud.compute_v1.types.SslPolicy]

kind

[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SslPoliciesListAvailableFeaturesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

features

Type

MutableSequence[str]

class google.cloud.compute_v1.types.SslPoliciesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ssl_policies

A list of SslPolicies contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.SslPolicy]

warning

Informational warning which replaces the list of SSL policies when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SslPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an SSL Policy resource. Use SSL policies to control SSL features, such as versions and cipher suites, that are offered by Application Load Balancers and proxy Network Load Balancers. For more information, read SSL policies overview.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

custom_features

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

Type

MutableSequence[str]

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

enabled_features

[Output Only] The list of features enabled in the SSL policy.

Type

MutableSequence[str]

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. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

This field is a member of oneof _kind.

Type

str

min_tls_version

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. Check the MinTlsVersion enum for the list of possible values.

This field is a member of oneof _min_tls_version.

Type

str

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.

This field is a member of oneof _name.

Type

str

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. Check the Profile enum for the list of possible values.

This field is a member of oneof _profile.

Type

str

region

[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

warnings

[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

Type

MutableSequence[google.cloud.compute_v1.types.Warnings]

class MinTlsVersion(value)

Bases: proto.enums.Enum

The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.

Values:

UNDEFINED_MIN_TLS_VERSION (0):

A value indicating that the enum field is not set.

TLS_1_0 (33116734):

TLS 1.0

TLS_1_1 (33116735):

TLS 1.1

TLS_1_2 (33116736):

TLS 1.2

class Profile(value)

Bases: proto.enums.Enum

Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.

Values:

UNDEFINED_PROFILE (0):

A value indicating that the enum field is not set.

COMPATIBLE (179357396):

Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.

CUSTOM (388595569):

Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.

MODERN (132013855):

Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.

RESTRICTED (261551195):

Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements.

class google.cloud.compute_v1.types.SslPolicyReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ssl_policy

URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.

This field is a member of oneof _ssl_policy.

Type

str

class google.cloud.compute_v1.types.StartAsyncReplicationDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.StartAsyncReplication. See the method description for details.

disk

The name of the persistent disk.

Type

str

disks_start_async_replication_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DisksStartAsyncReplicationRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.StartAsyncReplicationRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.StartAsyncReplication. See the method description for details.

disk

The name of the persistent disk.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

region_disks_start_async_replication_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionDisksStartAsyncReplicationRequest

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.StartInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Start. See the method description for details.

instance

Name of the instance resource to start.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.StartWithEncryptionKeyInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.StartWithEncryptionKey. See the method description for details.

instance

Name of the instance resource to start.

Type

str

instances_start_with_encryption_key_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstancesStartWithEncryptionKeyRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.StatefulPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

preserved_state

This field is a member of oneof _preserved_state.

Type

google.cloud.compute_v1.types.StatefulPolicyPreservedState

class google.cloud.compute_v1.types.StatefulPolicyPreservedState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration of preserved resources.

disks

Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.

Type

MutableMapping[str, google.cloud.compute_v1.types.StatefulPolicyPreservedStateDiskDevice]

external_i_ps

External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

Type

MutableMapping[str, google.cloud.compute_v1.types.StatefulPolicyPreservedStateNetworkIp]

internal_i_ps

Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

Type

MutableMapping[str, google.cloud.compute_v1.types.StatefulPolicyPreservedStateNetworkIp]

class DisksEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class ExternalIPsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class InternalIPsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.StatefulPolicyPreservedStateDiskDevice(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

auto_delete

These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. Check the AutoDelete enum for the list of possible values.

This field is a member of oneof _auto_delete.

Type

str

class AutoDelete(value)

Bases: proto.enums.Enum

These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.

Values:

UNDEFINED_AUTO_DELETE (0):

A value indicating that the enum field is not set.

NEVER (74175084):

No description available.

ON_PERMANENT_INSTANCE_DELETION (95727719):

No description available.

class google.cloud.compute_v1.types.StatefulPolicyPreservedStateNetworkIp(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

auto_delete

These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Check the AutoDelete enum for the list of possible values.

This field is a member of oneof _auto_delete.

Type

str

class AutoDelete(value)

Bases: proto.enums.Enum

These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

Values:

UNDEFINED_AUTO_DELETE (0):

A value indicating that the enum field is not set.

NEVER (74175084):

No description available.

ON_PERMANENT_INSTANCE_DELETION (95727719):

No description available.

class google.cloud.compute_v1.types.Status(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

code

The status code, which should be an enum value of google.rpc.Code.

This field is a member of oneof _code.

Type

int

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Type

MutableSequence[google.protobuf.any_pb2.Any]

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

This field is a member of oneof _message.

Type

str

class google.cloud.compute_v1.types.StopAsyncReplicationDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.StopAsyncReplication. See the method description for details.

disk

The name of the persistent disk.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.StopAsyncReplicationRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.StopAsyncReplication. See the method description for details.

disk

The name of the persistent disk.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.StopGroupAsyncReplicationDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.StopGroupAsyncReplication. See the method description for details.

disks_stop_group_async_replication_resource_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DisksStopGroupAsyncReplicationResource

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request. This must be the zone of the primary or secondary disks in the consistency group.

Type

str

class google.cloud.compute_v1.types.StopGroupAsyncReplicationRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.StopGroupAsyncReplication. See the method description for details.

disks_stop_group_async_replication_resource_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DisksStopGroupAsyncReplicationResource

project

Project ID for this request.

Type

str

region

The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.StopInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Stop. See the method description for details.

discard_local_ssd

This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.

This field is a member of oneof _discard_local_ssd.

Type

bool

instance

Name of the instance resource to stop.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.StoragePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a zonal storage pool resource.

capacity_provisioning_type

Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.

This field is a member of oneof _capacity_provisioning_type.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#storagePool for storage pools.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels to apply to this storage pool. These can be later modified by the setLabels method.

Type

MutableMapping[str, str]

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.

This field is a member of oneof _name.

Type

str

performance_provisioning_type

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. Check the PerformanceProvisioningType enum for the list of possible values.

This field is a member of oneof _performance_provisioning_type.

Type

str

pool_provisioned_capacity_gb

Size, in GiB, of the storage pool. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools.

This field is a member of oneof _pool_provisioned_capacity_gb.

Type

int

pool_provisioned_iops

Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.

This field is a member of oneof _pool_provisioned_iops.

Type

int

pool_provisioned_throughput

Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.

This field is a member of oneof _pool_provisioned_throughput.

Type

int

resource_status

[Output Only] Status information for the storage pool resource.

This field is a member of oneof _resource_status.

Type

google.cloud.compute_v1.types.StoragePoolResourceStatus

self_link

[Output Only] Server-defined fully-qualified URL for this resource.

This field is a member of oneof _self_link.

Type

str

self_link_with_id

[Output Only] Server-defined URL for this resource’s resource id.

This field is a member of oneof _self_link_with_id.

Type

str

state

[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

status

[Output Only] Status information for the storage pool resource.

This field is a member of oneof _status.

Type

google.cloud.compute_v1.types.StoragePoolResourceStatus

storage_pool_type

Type of the storage pool.

This field is a member of oneof _storage_pool_type.

Type

str

zone

[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _zone.

Type

str

class CapacityProvisioningType(value)

Bases: proto.enums.Enum

Provisioning type of the byte capacity of the pool. Additional supported values which may be not listed in the enum directly due to technical reasons:

ADVANCED STANDARD UNSPECIFIED

Values:

UNDEFINED_CAPACITY_PROVISIONING_TYPE (0):

A value indicating that the enum field is not set.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class PerformanceProvisioningType(value)

Bases: proto.enums.Enum

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. Additional supported values which may be not listed in the enum directly due to technical reasons:

ADVANCED STANDARD UNSPECIFIED

Values:

UNDEFINED_PERFORMANCE_PROVISIONING_TYPE (0):

A value indicating that the enum field is not set.

class State(value)

Bases: proto.enums.Enum

[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

CREATING (455564985):

StoragePool is provisioning

DELETING (528602024):

StoragePool is deleting.

FAILED (455706685):

StoragePool creation failed.

READY (77848963):

StoragePool is ready for use.

class google.cloud.compute_v1.types.StoragePoolAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

etag

This field is a member of oneof _etag.

Type

str

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of StoragePoolsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.StoragePoolsScopedList]

kind

[Output Only] Type of resource. Always compute#storagePoolAggregatedList for aggregated lists of storage pools.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.StoragePoolDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

attached_instances

[Output Only] Instances this disk is attached to.

Type

MutableSequence[str]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

disk

[Output Only] The URL of the disk.

This field is a member of oneof _disk.

Type

str

name

[Output Only] The name of the disk.

This field is a member of oneof _name.

Type

str

provisioned_iops

[Output Only] The number of IOPS provisioned for the disk.

This field is a member of oneof _provisioned_iops.

Type

int

provisioned_throughput

[Output Only] The throughput provisioned for the disk.

This field is a member of oneof _provisioned_throughput.

Type

int

resource_policies

[Output Only] Resource policies applied to disk for automatic snapshot creations.

Type

MutableSequence[str]

size_gb

[Output Only] The disk size, in GB.

This field is a member of oneof _size_gb.

Type

int

status

[Output Only] The disk status. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

type_

[Output Only] The disk type.

This field is a member of oneof _type.

Type

str

used_bytes

[Output Only] Amount of disk space used.

This field is a member of oneof _used_bytes.

Type

int

class Status(value)

Bases: proto.enums.Enum

[Output Only] The disk status.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

Disk is provisioning

DELETING (528602024):

Disk is deleting.

FAILED (455706685):

Disk creation failed.

READY (77848963):

Disk is ready for use.

RESTORING (404263851):

Source data is being copied into the disk.

UNAVAILABLE (413756464):

Disk is currently unavailable and cannot be accessed, attached or detached.

class google.cloud.compute_v1.types.StoragePoolList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of StoragePool resources.

etag

This field is a member of oneof _etag.

Type

str

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of StoragePool resources.

Type

MutableSequence[google.cloud.compute_v1.types.StoragePool]

kind

[Output Only] Type of resource. Always compute#storagePoolList for lists of storagePools.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.StoragePoolListDisks(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

etag

This field is a member of oneof _etag.

Type

str

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of StoragePoolDisk resources.

Type

MutableSequence[google.cloud.compute_v1.types.StoragePoolDisk]

kind

[Output Only] Type of resource. Always compute#storagePoolListDisks for lists of disks in a storagePool.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.StoragePoolResourceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] Contains output only fields.

disk_count

[Output Only] Number of disks used.

This field is a member of oneof _disk_count.

Type

int

last_resize_timestamp

[Output Only] Timestamp of the last successful resize in RFC3339 text format.

This field is a member of oneof _last_resize_timestamp.

Type

str

max_total_provisioned_disk_capacity_gb

[Output Only] Maximum allowed aggregate disk size in gigabytes.

This field is a member of oneof _max_total_provisioned_disk_capacity_gb.

Type

int

pool_used_capacity_bytes

[Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks.

This field is a member of oneof _pool_used_capacity_bytes.

Type

int

pool_used_iops

[Output Only] Sum of all the disks’ provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool’s IOPS capacity. For more information, see https://cloud.google.com/compute/docs/disks/storage-pools.

This field is a member of oneof _pool_used_iops.

Type

int

pool_used_throughput

[Output Only] Sum of all the disks’ provisioned throughput in MB/s.

This field is a member of oneof _pool_used_throughput.

Type

int

pool_user_written_bytes

[Output Only] Amount of data written into the pool, before it is compacted.

This field is a member of oneof _pool_user_written_bytes.

Type

int

total_provisioned_disk_capacity_gb

[Output Only] Sum of all the capacity provisioned in disks in this storage pool. A disk’s provisioned capacity is the same as its total capacity.

This field is a member of oneof _total_provisioned_disk_capacity_gb.

Type

int

total_provisioned_disk_iops

[Output Only] Sum of all the disks’ provisioned IOPS.

This field is a member of oneof _total_provisioned_disk_iops.

Type

int

total_provisioned_disk_throughput

[Output Only] Sum of all the disks’ provisioned throughput in MB/s, minus some amount that is allowed per disk that is not counted towards pool’s throughput capacity.

This field is a member of oneof _total_provisioned_disk_throughput.

Type

int

class google.cloud.compute_v1.types.StoragePoolType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

deprecated

[Output Only] The deprecation status associated with this storage pool type.

This field is a member of oneof _deprecated.

Type

google.cloud.compute_v1.types.DeprecationStatus

description

[Output Only] An optional description of this resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#storagePoolType for storage pool types.

This field is a member of oneof _kind.

Type

str

max_pool_provisioned_capacity_gb

[Output Only] Maximum storage pool size in GB.

This field is a member of oneof _max_pool_provisioned_capacity_gb.

Type

int

max_pool_provisioned_iops

[Output Only] Maximum provisioned IOPS.

This field is a member of oneof _max_pool_provisioned_iops.

Type

int

max_pool_provisioned_throughput

[Output Only] Maximum provisioned throughput.

This field is a member of oneof _max_pool_provisioned_throughput.

Type

int

min_pool_provisioned_capacity_gb

[Output Only] Minimum storage pool size in GB.

This field is a member of oneof _min_pool_provisioned_capacity_gb.

Type

int

min_pool_provisioned_iops

[Output Only] Minimum provisioned IOPS.

This field is a member of oneof _min_pool_provisioned_iops.

Type

int

min_pool_provisioned_throughput

[Output Only] Minimum provisioned throughput.

This field is a member of oneof _min_pool_provisioned_throughput.

Type

int

min_size_gb

[Deprecated] This field is deprecated. Use minPoolProvisionedCapacityGb instead.

This field is a member of oneof _min_size_gb.

Type

int

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

self_link_with_id

[Output Only] Server-defined URL for this resource with the resource id.

This field is a member of oneof _self_link_with_id.

Type

str

supported_disk_types

[Output Only] The list of disk types supported in this storage pool type.

Type

MutableSequence[str]

zone

[Output Only] URL of the zone where the storage pool type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

This field is a member of oneof _zone.

Type

str

class google.cloud.compute_v1.types.StoragePoolTypeAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of StoragePoolTypesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.StoragePoolTypesScopedList]

kind

[Output Only] Type of resource. Always compute#storagePoolTypeAggregatedList .

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.StoragePoolTypeList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of storage pool types.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of StoragePoolType resources.

Type

MutableSequence[google.cloud.compute_v1.types.StoragePoolType]

kind

[Output Only] Type of resource. Always compute#storagePoolTypeList for storage pool types.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.StoragePoolTypesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

storage_pool_types

[Output Only] A list of storage pool types contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.StoragePoolType]

warning

[Output Only] Informational warning which replaces the list of storage pool types when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.StoragePoolsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

storage_pools

[Output Only] A list of storage pool contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.StoragePool]

warning

[Output Only] Informational warning which replaces the list of storage pool when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.Subnetwork(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

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.

This field is a member of oneof _description.

Type

str

enable_flow_logs

Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn’t supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

This field is a member of oneof _enable_flow_logs.

Type

bool

external_ipv6_prefix

The external IPv6 address range that is owned by this subnetwork.

This field is a member of oneof _external_ipv6_prefix.

Type

str

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. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.

This field is a member of oneof _fingerprint.

Type

str

gateway_address

[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.

This field is a member of oneof _gateway_address.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

internal_ipv6_prefix

The internal IPv6 address range that is owned by this subnetwork.

This field is a member of oneof _internal_ipv6_prefix.

Type

str

ip_cidr_range

The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

This field is a member of oneof _ip_cidr_range.

Type

str

ipv6_access_type

The access type of IPv6 address this subnet holds. It’s immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. Check the Ipv6AccessType enum for the list of possible values.

This field is a member of oneof _ipv6_access_type.

Type

str

ipv6_cidr_range

[Output Only] This field is for internal use.

This field is a member of oneof _ipv6_cidr_range.

Type

str

kind

[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

This field is a member of oneof _kind.

Type

str

log_config

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

This field is a member of oneof _log_config.

Type

google.cloud.compute_v1.types.SubnetworkLogConfig

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.

This field is a member of oneof _name.

Type

str

network

The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.

This field is a member of oneof _network.

Type

str

private_ip_google_access

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.

This field is a member of oneof _private_ip_google_access.

Type

bool

private_ipv6_google_access

This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

This field is a member of oneof _private_ipv6_google_access.

Type

str

purpose

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn’t supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

This field is a member of oneof _purpose.

Type

str

region

URL of the region where the Subnetwork resides. This field can be set only at resource creation time.

This field is a member of oneof _region.

Type

str

reserved_internal_range

The URL of the reserved internal range.

This field is a member of oneof _reserved_internal_range.

Type

str

role

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. Check the Role enum for the list of possible values.

This field is a member of oneof _role.

Type

str

secondary_ip_ranges

An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.

Type

MutableSequence[google.cloud.compute_v1.types.SubnetworkSecondaryRange]

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

stack_type

The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. Check the StackType enum for the list of possible values.

This field is a member of oneof _stack_type.

Type

str

state

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

class Ipv6AccessType(value)

Bases: proto.enums.Enum

The access type of IPv6 address this subnet holds. It’s immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.

Values:

UNDEFINED_IPV6_ACCESS_TYPE (0):

A value indicating that the enum field is not set.

EXTERNAL (35607499):

VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.

INTERNAL (279295677):

VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network.

UNSPECIFIED_IPV6_ACCESS_TYPE (313080613):

No description available.

class PrivateIpv6GoogleAccess(value)

Bases: proto.enums.Enum

This field is for internal use. This field can be both set at resource creation time and updated using patch.

Values:

UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS (0):

A value indicating that the enum field is not set.

DISABLE_GOOGLE_ACCESS (450958579):

Disable private IPv6 access to/from Google services.

ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE (427975994):

Bidirectional private IPv6 access to/from Google services.

ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE (288210263):

Outbound private IPv6 access from VMs in this subnet to Google services.

class Purpose(value)

Bases: proto.enums.Enum

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn’t supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.

Values:

UNDEFINED_PURPOSE (0):

A value indicating that the enum field is not set.

GLOBAL_MANAGED_PROXY (236463602):

Subnet reserved for Global Envoy-based Load Balancing.

INTERNAL_HTTPS_LOAD_BALANCER (248748889):

Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.

PRIVATE (403485027):

Regular user created or automatically created subnet.

PRIVATE_NAT (367764517):

Subnetwork used as source range for Private NAT Gateways.

PRIVATE_RFC_1918 (254902107):

Regular user created or automatically created subnet.

PRIVATE_SERVICE_CONNECT (48134724):

Subnetworks created for Private Service Connect in the producer network.

REGIONAL_MANAGED_PROXY (153049966):

Subnetwork used for Regional Envoy-based Load Balancing.

class Role(value)

Bases: proto.enums.Enum

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.

Values:

UNDEFINED_ROLE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

The ACTIVE subnet that is currently used.

BACKUP (341010882):

The BACKUP subnet that could be promoted to ACTIVE.

class StackType(value)

Bases: proto.enums.Enum

The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.

Values:

UNDEFINED_STACK_TYPE (0):

A value indicating that the enum field is not set.

IPV4_IPV6 (22197249):

New VMs in this subnet can have both IPv4 and IPv6 addresses.

IPV4_ONLY (22373798):

New VMs in this subnet will only be assigned IPv4 addresses.

IPV6_ONLY (79632100):

New VMs in this subnet will only be assigned IPv6 addresses.

UNSPECIFIED_STACK_TYPE (298084569):

No description available.

class State(value)

Bases: proto.enums.Enum

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

DRAINING (480455402):

Subnetwork is being drained.

READY (77848963):

Subnetwork is ready for use.

class google.cloud.compute_v1.types.SubnetworkAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of SubnetworksScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.SubnetworksScopedList]

kind

[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.SubnetworkList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of Subnetwork resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Subnetwork resources.

Type

MutableSequence[google.cloud.compute_v1.types.Subnetwork]

kind

[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SubnetworkLogConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The available logging options for this subnetwork.

aggregation_interval

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. Check the AggregationInterval enum for the list of possible values.

This field is a member of oneof _aggregation_interval.

Type

str

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 determined by the org policy, if there is no org policy specified, then it will default to disabled. Flow logging isn’t supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

This field is a member of oneof _enable.

Type

bool

filter_expr

Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.

This field is a member of oneof _filter_expr.

Type

str

flow_sampling

Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.

This field is a member of oneof _flow_sampling.

Type

float

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 EXCLUDE_ALL_METADATA. Check the Metadata enum for the list of possible values.

This field is a member of oneof _metadata.

Type

str

metadata_fields

Can only be specified if VPC flow logs for this subnetwork is enabled and “metadata” was set to CUSTOM_METADATA.

Type

MutableSequence[str]

class AggregationInterval(value)

Bases: proto.enums.Enum

Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.

Values:

UNDEFINED_AGGREGATION_INTERVAL (0):

A value indicating that the enum field is not set.

INTERVAL_10_MIN (487155916):

No description available.

INTERVAL_15_MIN (491773521):

No description available.

INTERVAL_1_MIN (69052714):

No description available.

INTERVAL_30_SEC (7548937):

No description available.

INTERVAL_5_MIN (72746798):

No description available.

INTERVAL_5_SEC (72752429):

No description available.

class Metadata(value)

Bases: proto.enums.Enum

Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA.

Values:

UNDEFINED_METADATA (0):

A value indicating that the enum field is not set.

CUSTOM_METADATA (62450749):

No description available.

EXCLUDE_ALL_METADATA (334519954):

No description available.

INCLUDE_ALL_METADATA (164619908):

No description available.

class google.cloud.compute_v1.types.SubnetworkSecondaryRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a secondary IP range of a subnetwork.

ip_cidr_range

The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.

This field is a member of oneof _ip_cidr_range.

Type

str

range_name

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.

This field is a member of oneof _range_name.

Type

str

reserved_internal_range

The URL of the reserved internal range.

This field is a member of oneof _reserved_internal_range.

Type

str

class google.cloud.compute_v1.types.SubnetworksExpandIpCidrRangeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ip_cidr_range

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.

This field is a member of oneof _ip_cidr_range.

Type

str

class google.cloud.compute_v1.types.SubnetworksScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

subnetworks

A list of subnetworks contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.Subnetwork]

warning

An informational warning that appears when the list of addresses is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.SubnetworksSetPrivateIpGoogleAccessRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

private_ip_google_access

This field is a member of oneof _private_ip_google_access.

Type

bool

class google.cloud.compute_v1.types.Subsetting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.

policy

Check the Policy enum for the list of possible values.

This field is a member of oneof _policy.

Type

str

class Policy(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_POLICY (0):

A value indicating that the enum field is not set.

CONSISTENT_HASH_SUBSETTING (108989492):

Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled.

NONE (2402104):

No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends.

class google.cloud.compute_v1.types.SuspendInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Suspend. See the method description for details.

discard_local_ssd

This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.

This field is a member of oneof _discard_local_ssd.

Type

bool

instance

Name of the instance resource to suspend.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.SwitchToCustomModeNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.SwitchToCustomMode. See the method description for details.

network

Name of the network to be updated.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.TCPHealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

port

The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.

This field is a member of oneof _port.

Type

int

port_name

Not supported.

This field is a member of oneof _port_name.

Type

str

port_specification

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Check the PortSpecification enum for the list of possible values.

This field is a member of oneof _port_specification.

Type

str

proxy_header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

request

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

This field is a member of oneof _request.

Type

str

response

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

This field is a member of oneof _response.

Type

str

class PortSpecification(value)

Bases: proto.enums.Enum

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports.

Values:

UNDEFINED_PORT_SPECIFICATION (0):

A value indicating that the enum field is not set.

USE_FIXED_PORT (190235748):

The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.

USE_NAMED_PORT (349300671):

Not supported.

USE_SERVING_PORT (362637516):

For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.

class ProxyHeader(value)

Bases: proto.enums.Enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.Tags(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A set of instance 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. To see the latest fingerprint, make get() request to the instance.

This field is a member of oneof _fingerprint.

Type

str

items

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.TargetGrpcProxy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Target gRPC Proxy resource. A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Only global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can reference a target gRPC proxy. The target gRPC Proxy references a URL map that specifies how traffic is routed to gRPC backend services.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

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 TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy.

This field is a member of oneof _fingerprint.

Type

str

id

[Output Only] The unique identifier for the resource type. The server generates this identifier.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

self_link_with_id

[Output Only] Server-defined URL with id for the resource.

This field is a member of oneof _self_link_with_id.

Type

str

url_map

URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

This field is a member of oneof _url_map.

Type

str

validate_for_proxyless

If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use “xds:///” scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use “xds:///” scheme in the target URI of the service it is connecting to

This field is a member of oneof _validate_for_proxyless.

Type

bool

class google.cloud.compute_v1.types.TargetGrpcProxyList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetGrpcProxy resources.

Type

MutableSequence[google.cloud.compute_v1.types.TargetGrpcProxy]

kind

[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetHttpProxiesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target_http_proxies

A list of TargetHttpProxies contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.TargetHttpProxy]

warning

Informational warning which replaces the list of backend services when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetHttpProxy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * Global * Regional A target HTTP proxy is a component of Google Cloud HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

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 TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.

This field is a member of oneof _fingerprint.

Type

str

http_keep_alive_timeout_sec

Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For global external Application Load Balancers, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For classic Application Load Balancers, this option is not supported.

This field is a member of oneof _http_keep_alive_timeout_sec.

Type

int

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

proxy_bind

This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.

This field is a member of oneof _proxy_bind.

Type

bool

region

[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

url_map

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

This field is a member of oneof _url_map.

Type

str

class google.cloud.compute_v1.types.TargetHttpProxyAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetHttpProxiesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.TargetHttpProxiesScopedList]

kind

[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.TargetHttpProxyList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of TargetHttpProxy resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetHttpProxy resources.

Type

MutableSequence[google.cloud.compute_v1.types.TargetHttpProxy]

kind

Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetHttpsProxiesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target_https_proxies

A list of TargetHttpsProxies contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.TargetHttpsProxy]

warning

Informational warning which replaces the list of backend services when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetHttpsProxiesSetCertificateMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

certificate_map

URL of the Certificate Map to associate with this TargetHttpsProxy. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

This field is a member of oneof _certificate_map.

Type

str

class google.cloud.compute_v1.types.TargetHttpsProxiesSetQuicOverrideRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

quic_override

QUIC policy for the TargetHttpsProxy resource. Check the QuicOverride enum for the list of possible values.

This field is a member of oneof _quic_override.

Type

str

class QuicOverride(value)

Bases: proto.enums.Enum

QUIC policy for the TargetHttpsProxy resource.

Values:

UNDEFINED_QUIC_OVERRIDE (0):

A value indicating that the enum field is not set.

DISABLE (241807048):

The load balancer will not attempt to negotiate QUIC with clients.

ENABLE (438835587):

The load balancer will attempt to negotiate QUIC with clients.

NONE (2402104):

No overrides to the default QUIC policy. This option is implicit if no QUIC override has been specified in the request.

class google.cloud.compute_v1.types.TargetHttpsProxiesSetSslCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ssl_certificates

New set of SslCertificate resources to associate with this TargetHttpsProxy resource. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.TargetHttpsProxy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * Global * Regional A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.

authorization_policy

Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact.

This field is a member of oneof _authorization_policy.

Type

str

certificate_map

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

This field is a member of oneof _certificate_map.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

This field is a member of oneof _fingerprint.

Type

str

http_keep_alive_timeout_sec

Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For global external Application Load Balancers, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For classic Application Load Balancers, this option is not supported.

This field is a member of oneof _http_keep_alive_timeout_sec.

Type

int

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

proxy_bind

This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.

This field is a member of oneof _proxy_bind.

Type

bool

quic_override

Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn’t use QUIC. - If the quic-override flag is not specified, NONE is implied. Check the QuicOverride enum for the list of possible values.

This field is a member of oneof _quic_override.

Type

str

region

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

server_tls_policy

Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.

This field is a member of oneof _server_tls_policy.

Type

str

ssl_certificates

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

Type

MutableSequence[str]

ssl_policy

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

This field is a member of oneof _ssl_policy.

Type

str

tls_early_data

Specifies whether TLS 1.3 0-RTT Data (“Early Data”) should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to “zero”. This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the “Early-Data” HTTP header set on the request, with a value of “1”, to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the “Early-Data: 1” HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED. Check the TlsEarlyData enum for the list of possible values.

This field is a member of oneof _tls_early_data.

Type

str

url_map

A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map

This field is a member of oneof _url_map.

Type

str

class QuicOverride(value)

Bases: proto.enums.Enum

Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn’t use QUIC. - If the quic-override flag is not specified, NONE is implied.

Values:

UNDEFINED_QUIC_OVERRIDE (0):

A value indicating that the enum field is not set.

DISABLE (241807048):

The load balancer will not attempt to negotiate QUIC with clients.

ENABLE (438835587):

The load balancer will attempt to negotiate QUIC with clients.

NONE (2402104):

No overrides to the default QUIC policy. This option is implicit if no QUIC override has been specified in the request.

class TlsEarlyData(value)

Bases: proto.enums.Enum

Specifies whether TLS 1.3 0-RTT Data (“Early Data”) should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to “zero”. This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the “Early-Data” HTTP header set on the request, with a value of “1”, to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the “Early-Data: 1” HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED.

Values:

UNDEFINED_TLS_EARLY_DATA (0):

A value indicating that the enum field is not set.

DISABLED (516696700):

TLS 1.3 Early Data is not advertised, and any (invalid) attempts to send Early Data will be rejected by closing the connection.

PERMISSIVE (504345247):

This enables TLS 1.3 0-RTT, and only allows Early Data to be included on requests with safe HTTP methods (GET, HEAD, OPTIONS, TRACE). This mode does not enforce any other limitations for requests with Early Data. The application owner should validate that Early Data is acceptable for a given request path.

STRICT (308826825):

This enables TLS 1.3 0-RTT, and only allows Early Data to be included on requests with safe HTTP methods (GET, HEAD, OPTIONS, TRACE) without query parameters. Requests that send Early Data with non-idempotent HTTP methods or with query parameters will be rejected with a HTTP 425.

class google.cloud.compute_v1.types.TargetHttpsProxyAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetHttpsProxiesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.TargetHttpsProxiesScopedList]

kind

[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.TargetHttpsProxyList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of TargetHttpsProxy resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetHttpsProxy resources.

Type

MutableSequence[google.cloud.compute_v1.types.TargetHttpsProxy]

kind

Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance

This field is a member of oneof _instance.

Type

str

kind

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

nat_policy

Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance. Check the NatPolicy enum for the list of possible values.

This field is a member of oneof _nat_policy.

Type

str

network

The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.

This field is a member of oneof _network.

Type

str

security_policy

[Output Only] The resource URL for the security policy associated with this target instance.

This field is a member of oneof _security_policy.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

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.

This field is a member of oneof _zone.

Type

str

class NatPolicy(value)

Bases: proto.enums.Enum

Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.

Values:

UNDEFINED_NAT_POLICY (0):

A value indicating that the enum field is not set.

NO_NAT (161455491):

No NAT performed.

class google.cloud.compute_v1.types.TargetInstanceAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetInstance resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.TargetInstancesScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.TargetInstanceList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of TargetInstance resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetInstance resources.

Type

MutableSequence[google.cloud.compute_v1.types.TargetInstance]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetInstancesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target_instances

A list of target instances contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.TargetInstance]

warning

Informational warning which replaces the list of addresses when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetPool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Target Pool resource. Target pools are used with external passthrough Network Load Balancers. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.

backup_pool

The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

This field is a member of oneof _backup_pool.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

failover_ratio

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

This field is a member of oneof _failover_ratio.

Type

float

health_checks

The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

Type

MutableSequence[str]

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

instances

A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

Type

MutableSequence[str]

kind

[Output Only] Type of the resource. Always compute#targetPool for target pools.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

region

[Output Only] URL of the region where the target pool resides.

This field is a member of oneof _region.

Type

str

security_policy

[Output Only] The resource URL for the security policy associated with this target pool.

This field is a member of oneof _security_policy.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

session_affinity

Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. Check the SessionAffinity enum for the list of possible values.

This field is a member of oneof _session_affinity.

Type

str

class SessionAffinity(value)

Bases: proto.enums.Enum

Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

Values:

UNDEFINED_SESSION_AFFINITY (0):

A value indicating that the enum field is not set.

CLIENT_IP (345665051):

2-tuple hash on packet’s source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.

CLIENT_IP_NO_DESTINATION (106122516):

1-tuple hash only on packet’s source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.

CLIENT_IP_PORT_PROTO (221722926):

5-tuple hash on packet’s source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.

CLIENT_IP_PROTO (25322148):

3-tuple hash on packet’s source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.

GENERATED_COOKIE (370321204):

Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.

HEADER_FIELD (200737960):

The hash is based on a user specified header field.

HTTP_COOKIE (494981627):

The hash is based on a user provided cookie.

NONE (2402104):

No session affinity. Connections from the same client IP may go to any instance in the pool.

STRONG_COOKIE_AFFINITY (438628091):

Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired.

class google.cloud.compute_v1.types.TargetPoolAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetPool resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.TargetPoolsScopedList]

kind

[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.TargetPoolInstanceHealth(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

health_status

Type

MutableSequence[google.cloud.compute_v1.types.HealthStatus]

kind

[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.

This field is a member of oneof _kind.

Type

str

class google.cloud.compute_v1.types.TargetPoolList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of TargetPool resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetPool resources.

Type

MutableSequence[google.cloud.compute_v1.types.TargetPool]

kind

[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetPoolsAddHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

health_checks

The HttpHealthCheck to add to the target pool.

Type

MutableSequence[google.cloud.compute_v1.types.HealthCheckReference]

class google.cloud.compute_v1.types.TargetPoolsAddInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone /instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name

Type

MutableSequence[google.cloud.compute_v1.types.InstanceReference]

class google.cloud.compute_v1.types.TargetPoolsRemoveHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

health_checks

Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project /global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check

Type

MutableSequence[google.cloud.compute_v1.types.HealthCheckReference]

class google.cloud.compute_v1.types.TargetPoolsRemoveInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

instances

URLs of the instances to be removed from target pool.

Type

MutableSequence[google.cloud.compute_v1.types.InstanceReference]

class google.cloud.compute_v1.types.TargetPoolsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target_pools

A list of target pools contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.TargetPool]

warning

Informational warning which replaces the list of addresses when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target

This field is a member of oneof _target.

Type

str

class google.cloud.compute_v1.types.TargetSslProxiesSetBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

service

The URL of the new BackendService resource for the targetSslProxy.

This field is a member of oneof _service.

Type

str

class google.cloud.compute_v1.types.TargetSslProxiesSetCertificateMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

certificate_map

URL of the Certificate Map to associate with this TargetSslProxy. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

This field is a member of oneof _certificate_map.

Type

str

class google.cloud.compute_v1.types.TargetSslProxiesSetProxyHeaderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

proxy_header

The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

class ProxyHeader(value)

Bases: proto.enums.Enum

The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.TargetSslProxiesSetSslCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ssl_certificates

New set of URLs to SslCertificate resources to associate with this TargetSslProxy. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.TargetSslProxy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Target SSL Proxy resource. A target SSL proxy is a component of a Proxy Network Load Balancer. The forwarding rule references the target SSL proxy, and the target proxy then references a backend service. For more information, read Proxy Network Load Balancer overview.

certificate_map

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

This field is a member of oneof _certificate_map.

Type

str

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

proxy_header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

service

URL to the BackendService resource.

This field is a member of oneof _service.

Type

str

ssl_certificates

URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

Type

MutableSequence[str]

ssl_policy

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.

This field is a member of oneof _ssl_policy.

Type

str

class ProxyHeader(value)

Bases: proto.enums.Enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.TargetSslProxyList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of TargetSslProxy resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetSslProxy resources.

Type

MutableSequence[google.cloud.compute_v1.types.TargetSslProxy]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetTcpProxiesScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target_tcp_proxies

A list of TargetTcpProxies contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.TargetTcpProxy]

warning

Informational warning which replaces the list of backend services when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetTcpProxiesSetBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

service

The URL of the new BackendService resource for the targetTcpProxy.

This field is a member of oneof _service.

Type

str

class google.cloud.compute_v1.types.TargetTcpProxiesSetProxyHeaderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

proxy_header

The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

class ProxyHeader(value)

Bases: proto.enums.Enum

The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.TargetTcpProxy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Target TCP Proxy resource. A target TCP proxy is a component of a Proxy Network Load Balancer. The forwarding rule references the target TCP proxy, and the target proxy then references a backend service. For more information, read Proxy Network Load Balancer overview.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

proxy_bind

This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.

This field is a member of oneof _proxy_bind.

Type

bool

proxy_header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

This field is a member of oneof _proxy_header.

Type

str

region

[Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

service

URL to the BackendService resource.

This field is a member of oneof _service.

Type

str

class ProxyHeader(value)

Bases: proto.enums.Enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Values:

UNDEFINED_PROXY_HEADER (0):

A value indicating that the enum field is not set.

NONE (2402104):

No description available.

PROXY_V1 (334352940):

No description available.

class google.cloud.compute_v1.types.TargetTcpProxyAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetTcpProxiesScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.TargetTcpProxiesScopedList]

kind

[Output Only] Type of resource. Always compute#targetTcpProxyAggregatedList for lists of Target TCP Proxies.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.TargetTcpProxyList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of TargetTcpProxy resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetTcpProxy resources.

Type

MutableSequence[google.cloud.compute_v1.types.TargetTcpProxy]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetVpnGateway(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

forwarding_rules

[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.

Type

MutableSequence[str]

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Type

MutableMapping[str, str]

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.

This field is a member of oneof _name.

Type

str

network

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

This field is a member of oneof _network.

Type

str

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.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

status

[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

tunnels

[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.

Type

MutableSequence[str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

CREATING (455564985):

No description available.

DELETING (528602024):

No description available.

FAILED (455706685):

No description available.

READY (77848963):

No description available.

class google.cloud.compute_v1.types.TargetVpnGatewayAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetVpnGateway resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.TargetVpnGatewaysScopedList]

kind

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.TargetVpnGatewayList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of TargetVpnGateway resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of TargetVpnGateway resources.

Type

MutableSequence[google.cloud.compute_v1.types.TargetVpnGateway]

kind

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TargetVpnGatewaysScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

target_vpn_gateways

[Output Only] A list of target VPN gateways contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.TargetVpnGateway]

warning

[Output Only] Informational warning which replaces the list of addresses when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.TestFailure(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

actual_output_url

The actual output URL evaluated by a load balancer containing the scheme, host, path and query parameters.

This field is a member of oneof _actual_output_url.

Type

str

actual_redirect_response_code

Actual HTTP status code for rule with urlRedirect calculated by load balancer

This field is a member of oneof _actual_redirect_response_code.

Type

int

actual_service

BackendService or BackendBucket returned by load balancer.

This field is a member of oneof _actual_service.

Type

str

expected_output_url

The expected output URL evaluated by a load balancer containing the scheme, host, path and query parameters.

This field is a member of oneof _expected_output_url.

Type

str

expected_redirect_response_code

Expected HTTP status code for rule with urlRedirect calculated by load balancer

This field is a member of oneof _expected_redirect_response_code.

Type

int

expected_service

Expected BackendService or BackendBucket resource the given URL should be mapped to.

This field is a member of oneof _expected_service.

Type

str

headers

HTTP headers of the request.

Type

MutableSequence[google.cloud.compute_v1.types.UrlMapTestHeader]

host

Host portion of the URL.

This field is a member of oneof _host.

Type

str

path

Path portion including query parameters in the URL.

This field is a member of oneof _path.

Type

str

class google.cloud.compute_v1.types.TestIamPermissionsBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.TestIamPermissionsExternalVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ExternalVpnGateways.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for FirewallPolicies.TestIamPermissions. See the method description for details.

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Images.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.TestIamPermissionsInstanceTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceTemplates.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstantSnapshots.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.TestIamPermissionsLicenseCodeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for LicenseCodes.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Licenses.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsMachineImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for MachineImages.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsNetworkAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkAttachments.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsNetworkEndpointGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkEndpointGroups.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.TestIamPermissionsNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NetworkFirewallPolicies.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsNodeGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeGroups.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.TestIamPermissionsNodeTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for NodeTemplates.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsPacketMirroringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PacketMirrorings.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsRegionInstantSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstantSnapshots.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsRegionNetworkFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionNetworkFirewallPolicies.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.TestIamPermissionsResourcePolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ResourcePolicies.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsServiceAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ServiceAttachments.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Snapshots.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsStoragePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.TestIamPermissionsSubnetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Subnetworks.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestIamPermissionsVpnGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for VpnGateways.TestIamPermissions. See the method description for details.

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

resource

Name or id of the resource for this request.

Type

str

test_permissions_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.TestPermissionsRequest

class google.cloud.compute_v1.types.TestPermissionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

permissions

The set of permissions to check for the ‘resource’. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.TestPermissionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

permissions

A subset of TestPermissionsRequest.permissions that the caller is allowed.

Type

MutableSequence[str]

class google.cloud.compute_v1.types.Uint128(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

high

This field is a member of oneof _high.

Type

int

low

This field is a member of oneof _low.

Type

int

class google.cloud.compute_v1.types.UpcomingMaintenance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Upcoming Maintenance notification information.

can_reschedule

Indicates if the maintenance can be customer triggered.

This field is a member of oneof _can_reschedule.

Type

bool

latest_window_start_time

The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.

This field is a member of oneof _latest_window_start_time.

Type

str

maintenance_status

Check the MaintenanceStatus enum for the list of possible values.

This field is a member of oneof _maintenance_status.

Type

str

type_

Defines the type of maintenance. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

window_end_time

The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.

This field is a member of oneof _window_end_time.

Type

str

window_start_time

The current start time of the maintenance window. This timestamp value is in RFC3339 text format.

This field is a member of oneof _window_start_time.

Type

str

class MaintenanceStatus(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_MAINTENANCE_STATUS (0):

A value indicating that the enum field is not set.

ONGOING (473158491):

There is ongoing maintenance on this VM.

PENDING (35394935):

There is pending maintenance.

UNKNOWN (433141802):

Unknown maintenance status. Do not use this value.

class Type(value)

Bases: proto.enums.Enum

Defines the type of maintenance.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

SCHEDULED (478400653):

Scheduled maintenance (e.g. maintenance after uptime guarantee is complete).

UNKNOWN_TYPE (490705455):

No type specified. Do not use this value.

UNSCHEDULED (450077204):

Unscheduled maintenance (e.g. emergency maintenance during uptime guarantee).

class google.cloud.compute_v1.types.UpdateAccessConfigInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.UpdateAccessConfig. See the method description for details.

access_config_resource

The body resource for this request

Type

google.cloud.compute_v1.types.AccessConfig

instance

The instance name for this request.

Type

str

network_interface

The name of the network interface where the access config is attached.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.UpdateAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Autoscalers.Update. See the method description for details.

autoscaler

Name of the autoscaler to update.

This field is a member of oneof _autoscaler.

Type

str

autoscaler_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Autoscaler

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.UpdateBackendBucketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendBuckets.Update. See the method description for details.

backend_bucket

Name of the BackendBucket resource to update.

Type

str

backend_bucket_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendBucket

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdateBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for BackendServices.Update. See the method description for details.

backend_service

Name of the BackendService resource to update.

Type

str

backend_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendService

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdateDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Disks.Update. See the method description for details.

disk

The disk name for this request.

Type

str

disk_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Disk

paths

This field is a member of oneof _paths.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

update_mask

update_mask indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.UpdateDisplayDeviceInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.UpdateDisplayDevice. See the method description for details.

display_device_resource

The body resource for this request

Type

google.cloud.compute_v1.types.DisplayDevice

instance

Name of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.UpdateFirewallRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Firewalls.Update. See the method description for details.

firewall

Name of the firewall rule to update.

Type

str

firewall_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Firewall

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdateHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for HealthChecks.Update. See the method description for details.

health_check

Name of the HealthCheck resource to update.

Type

str

health_check_resource

The body resource for this request

Type

google.cloud.compute_v1.types.HealthCheck

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.Update. See the method description for details.

instance

Name of the instance resource to update.

Type

str

instance_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Instance

minimal_action

Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Check the MinimalAction enum for the list of possible values.

This field is a member of oneof _minimal_action.

Type

str

most_disruptive_allowed_action

Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Check the MostDisruptiveAllowedAction enum for the list of possible values.

This field is a member of oneof _most_disruptive_allowed_action.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class MinimalAction(value)

Bases: proto.enums.Enum

Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Additional supported values which may be not listed in the enum directly due to technical reasons: INVALID NO_EFFECT REFRESH RESTART

Values:

UNDEFINED_MINIMAL_ACTION (0):

A value indicating that the enum field is not set.

class MostDisruptiveAllowedAction(value)

Bases: proto.enums.Enum

Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Additional supported values which may be not listed in the enum directly due to technical reasons: INVALID NO_EFFECT REFRESH RESTART

Values:

UNDEFINED_MOST_DISRUPTIVE_ALLOWED_ACTION (0):

A value indicating that the enum field is not set.

class google.cloud.compute_v1.types.UpdateNetworkInterfaceInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.UpdateNetworkInterface. See the method description for details.

instance

The instance name for this request.

Type

str

network_interface

The name of the network interface to update.

Type

str

network_interface_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworkInterface

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.UpdatePeeringNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Networks.UpdatePeering. See the method description for details.

network

Name of the network resource which the updated peering is belonging to.

Type

str

networks_update_peering_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.NetworksUpdatePeeringRequest

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdatePerInstanceConfigsInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for InstanceGroupManagers.UpdatePerInstanceConfigs. See the method description for details.

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

instance_group_managers_update_per_instance_configs_req_resource

The body resource for this request

Type

google.cloud.compute_v1.types.InstanceGroupManagersUpdatePerInstanceConfigsReq

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

zone

The name of the zone where the managed instance group is located. It should conform to RFC1035.

Type

str

class google.cloud.compute_v1.types.UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionInstanceGroupManagers.UpdatePerInstanceConfigs. See the method description for details.

instance_group_manager

The name of the managed instance group. It should conform to RFC1035.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region scoping this request, should conform to RFC1035.

Type

str

region_instance_group_manager_update_instance_config_req_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionInstanceGroupManagerUpdateInstanceConfigReq

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdateRegionAutoscalerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionAutoscalers.Update. See the method description for details.

autoscaler

Name of the autoscaler to update.

This field is a member of oneof _autoscaler.

Type

str

autoscaler_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Autoscaler

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdateRegionBackendServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionBackendServices.Update. See the method description for details.

backend_service

Name of the BackendService resource to update.

Type

str

backend_service_resource

The body resource for this request

Type

google.cloud.compute_v1.types.BackendService

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdateRegionCommitmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionCommitments.Update. See the method description for details.

commitment

Name of the commitment for which auto renew is being updated.

Type

str

commitment_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Commitment

paths

This field is a member of oneof _paths.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

update_mask

update_mask indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

class google.cloud.compute_v1.types.UpdateRegionDiskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionDisks.Update. See the method description for details.

disk

The disk name for this request.

Type

str

disk_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Disk

paths

This field is a member of oneof _paths.

Type

str

project

Project ID for this request.

Type

str

region

The name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

update_mask

update_mask indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

class google.cloud.compute_v1.types.UpdateRegionHealthCheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionHealthChecks.Update. See the method description for details.

health_check

Name of the HealthCheck resource to update.

Type

str

health_check_resource

The body resource for this request

Type

google.cloud.compute_v1.types.HealthCheck

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.UpdateRegionUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionUrlMaps.Update. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

request_id

begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

This field is a member of oneof _request_id.

Type

str

url_map

Name of the UrlMap resource to update.

Type

str

url_map_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMap

class google.cloud.compute_v1.types.UpdateReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Reservations.Update. See the method description for details.

paths

This field is a member of oneof _paths.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

reservation

Name of the reservation to update.

Type

str

reservation_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Reservation

update_mask

Update_mask indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.UpdateRouterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Routers.Update. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

router

Name of the Router resource to update.

Type

str

router_resource

The body resource for this request

Type

google.cloud.compute_v1.types.Router

class google.cloud.compute_v1.types.UpdateShieldedInstanceConfigInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for Instances.UpdateShieldedInstanceConfig. See the method description for details.

instance

Name or id of the instance scoping this request.

Type

str

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

shielded_instance_config_resource

The body resource for this request

Type

google.cloud.compute_v1.types.ShieldedInstanceConfig

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.UpdateStoragePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for StoragePools.Update. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

storage_pool

The storagePool name for this request.

Type

str

storage_pool_resource

The body resource for this request

Type

google.cloud.compute_v1.types.StoragePool

update_mask

update_mask indicates fields to be updated as part of this request.

This field is a member of oneof _update_mask.

Type

str

zone

The name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.UpdateUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.Update. See the method description for details.

project

Project ID for this request.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

url_map

Name of the UrlMap resource to update.

Type

str

url_map_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMap

class google.cloud.compute_v1.types.UrlMap(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a URL Map resource. Compute Engine has two URL Map resources: * Global * Regional A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by global external Application Load Balancers, classic Application Load Balancers, and cross-region internal Application Load Balancers. * regionUrlMaps are used by internal Application Load Balancers, regional external Application Load Balancers and regional internal Application Load Balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL, EXTERNAL_MANAGED, or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

default_custom_error_response_policy

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

This field is a member of oneof _default_custom_error_response_policy.

Type

google.cloud.compute_v1.types.CustomErrorResponsePolicy

default_route_action

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

This field is a member of oneof _default_route_action.

Type

google.cloud.compute_v1.types.HttpRouteAction

default_service

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don’t set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

This field is a member of oneof _default_service.

Type

str

default_url_redirect

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

This field is a member of oneof _default_url_redirect.

Type

google.cloud.compute_v1.types.HttpRedirectAction

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

fingerprint

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

This field is a member of oneof _fingerprint.

Type

str

header_action

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

This field is a member of oneof _header_action.

Type

google.cloud.compute_v1.types.HttpHeaderAction

host_rules

The list of host rules to use against the URL.

Type

MutableSequence[google.cloud.compute_v1.types.HostRule]

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

This field is a member of oneof _kind.

Type

str

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.

This field is a member of oneof _name.

Type

str

path_matchers

The list of named PathMatchers to use against the URL.

Type

MutableSequence[google.cloud.compute_v1.types.PathMatcher]

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.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

tests

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Type

MutableSequence[google.cloud.compute_v1.types.UrlMapTest]

class google.cloud.compute_v1.types.UrlMapList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of UrlMap resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of UrlMap resources.

Type

MutableSequence[google.cloud.compute_v1.types.UrlMap]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.UrlMapReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

url_map

This field is a member of oneof _url_map.

Type

str

class google.cloud.compute_v1.types.UrlMapTest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Message for the expected URL mappings.

description

Description of this test case.

This field is a member of oneof _description.

Type

str

expected_output_url

The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer’s redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

This field is a member of oneof _expected_output_url.

Type

str

expected_redirect_response_code

For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer’s redirect response. expectedRedirectResponseCode cannot be set when service is set.

This field is a member of oneof _expected_redirect_response_code.

Type

int

headers

HTTP headers for this request. If headers contains a host header, then host must also match the header value.

Type

MutableSequence[google.cloud.compute_v1.types.UrlMapTestHeader]

host

Host portion of the URL. If headers contains a host header, then host must also match the header value.

This field is a member of oneof _host.

Type

str

path

Path portion of the URL.

This field is a member of oneof _path.

Type

str

service

Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.

This field is a member of oneof _service.

Type

str

class google.cloud.compute_v1.types.UrlMapTestHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

HTTP headers used in UrlMapTests.

name

Header name.

This field is a member of oneof _name.

Type

str

value

Header value.

This field is a member of oneof _value.

Type

str

class google.cloud.compute_v1.types.UrlMapValidationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Message representing the validation result for a UrlMap.

load_errors

Type

MutableSequence[str]

load_succeeded

Whether the given UrlMap can be successfully loaded. If false, ‘loadErrors’ indicates the reasons.

This field is a member of oneof _load_succeeded.

Type

bool

test_failures

Type

MutableSequence[google.cloud.compute_v1.types.TestFailure]

test_passed

If successfully loaded, this field indicates whether the test passed. If false, ‘testFailures’s indicate the reason of failure.

This field is a member of oneof _test_passed.

Type

bool

class google.cloud.compute_v1.types.UrlMapsAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of UrlMapsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.UrlMapsScopedList]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.UrlMapsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

url_maps

A list of UrlMaps contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.UrlMap]

warning

Informational warning which replaces the list of backend services when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.UrlMapsValidateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

load_balancing_schemes

Specifies the load balancer type(s) this validation request is for. Use EXTERNAL_MANAGED for global external Application Load Balancers and regional external Application Load Balancers. Use EXTERNAL for classic Application Load Balancers. Use INTERNAL_MANAGED for internal Application Load Balancers. For more information, refer to Choosing a load balancer. If unspecified, the load balancing scheme will be inferred from the backend service resources this URL map references. If that can not be inferred (for example, this URL map only references backend buckets, or this Url map is for rewrites and redirects only and doesn’t reference any backends), EXTERNAL will be used as the default type. If specified, the scheme(s) must not conflict with the load balancing scheme of the backend service resources this Url map references. Check the LoadBalancingSchemes enum for the list of possible values.

Type

MutableSequence[str]

resource

Content of the UrlMap to be validated.

This field is a member of oneof _resource.

Type

google.cloud.compute_v1.types.UrlMap

class LoadBalancingSchemes(value)

Bases: proto.enums.Enum

Values:

UNDEFINED_LOAD_BALANCING_SCHEMES (0):

A value indicating that the enum field is not set.

EXTERNAL (35607499):

Signifies that this will be used for classic Application Load Balancers.

EXTERNAL_MANAGED (512006923):

Signifies that this will be used for Envoy-based global external Application Load Balancers.

LOAD_BALANCING_SCHEME_UNSPECIFIED (526507452):

If unspecified, the validation will try to infer the scheme from the backend service resources this Url map references. If the inference is not possible, EXTERNAL will be used as the default type.

class google.cloud.compute_v1.types.UrlMapsValidateResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

result

This field is a member of oneof _result.

Type

google.cloud.compute_v1.types.UrlMapValidationResult

class google.cloud.compute_v1.types.UrlRewrite(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The spec for modifying the path before sending the request to the matched backend service.

host_rewrite

Before forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.

This field is a member of oneof _host_rewrite.

Type

str

path_prefix_rewrite

Before forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.

This field is a member of oneof _path_prefix_rewrite.

Type

str

path_template_rewrite

If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or {var=**}. For example, a path_template_match of /static/{format=**} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=**} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.

This field is a member of oneof _path_template_rewrite.

Type

str

class google.cloud.compute_v1.types.UsableSubnetwork(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Subnetwork which the current user has compute.subnetworks.use permission on.

external_ipv6_prefix

[Output Only] The external IPv6 address range that is assigned to this subnetwork.

This field is a member of oneof _external_ipv6_prefix.

Type

str

internal_ipv6_prefix

[Output Only] The internal IPv6 address range that is assigned to this subnetwork.

This field is a member of oneof _internal_ipv6_prefix.

Type

str

ip_cidr_range

The range of internal addresses that are owned by this subnetwork.

This field is a member of oneof _ip_cidr_range.

Type

str

ipv6_access_type

The access type of IPv6 address this subnet holds. It’s immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. Check the Ipv6AccessType enum for the list of possible values.

This field is a member of oneof _ipv6_access_type.

Type

str

network

Network URL.

This field is a member of oneof _network.

Type

str

purpose

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn’t supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

This field is a member of oneof _purpose.

Type

str

role

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. Check the Role enum for the list of possible values.

This field is a member of oneof _role.

Type

str

secondary_ip_ranges

Secondary IP ranges.

Type

MutableSequence[google.cloud.compute_v1.types.UsableSubnetworkSecondaryRange]

stack_type

The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. Check the StackType enum for the list of possible values.

This field is a member of oneof _stack_type.

Type

str

subnetwork

Subnetwork URL.

This field is a member of oneof _subnetwork.

Type

str

class Ipv6AccessType(value)

Bases: proto.enums.Enum

The access type of IPv6 address this subnet holds. It’s immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.

Values:

UNDEFINED_IPV6_ACCESS_TYPE (0):

A value indicating that the enum field is not set.

EXTERNAL (35607499):

VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.

INTERNAL (279295677):

VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network.

class Purpose(value)

Bases: proto.enums.Enum

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn’t supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.

Values:

UNDEFINED_PURPOSE (0):

A value indicating that the enum field is not set.

GLOBAL_MANAGED_PROXY (236463602):

Subnet reserved for Global Envoy-based Load Balancing.

INTERNAL_HTTPS_LOAD_BALANCER (248748889):

Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.

PRIVATE (403485027):

Regular user created or automatically created subnet.

PRIVATE_NAT (367764517):

Subnetwork used as source range for Private NAT Gateways.

PRIVATE_RFC_1918 (254902107):

Regular user created or automatically created subnet.

PRIVATE_SERVICE_CONNECT (48134724):

Subnetworks created for Private Service Connect in the producer network.

REGIONAL_MANAGED_PROXY (153049966):

Subnetwork used for Regional Envoy-based Load Balancing.

class Role(value)

Bases: proto.enums.Enum

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.

Values:

UNDEFINED_ROLE (0):

A value indicating that the enum field is not set.

ACTIVE (314733318):

The ACTIVE subnet that is currently used.

BACKUP (341010882):

The BACKUP subnet that could be promoted to ACTIVE.

class StackType(value)

Bases: proto.enums.Enum

The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.

Values:

UNDEFINED_STACK_TYPE (0):

A value indicating that the enum field is not set.

IPV4_IPV6 (22197249):

New VMs in this subnet can have both IPv4 and IPv6 addresses.

IPV4_ONLY (22373798):

New VMs in this subnet will only be assigned IPv4 addresses.

IPV6_ONLY (79632100):

New VMs in this subnet will only be assigned IPv6 addresses.

class google.cloud.compute_v1.types.UsableSubnetworkSecondaryRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Secondary IP range of a usable subnetwork.

ip_cidr_range

The range of IP addresses belonging to this subnetwork secondary range.

This field is a member of oneof _ip_cidr_range.

Type

str

range_name

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.

This field is a member of oneof _range_name.

Type

str

class google.cloud.compute_v1.types.UsableSubnetworksAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

str

items

[Output] A list of usable subnetwork URLs.

Type

MutableSequence[google.cloud.compute_v1.types.UsableSubnetwork]

kind

[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. In special cases listUsable may return 0 subnetworks and nextPageToken which still should be used to get the next page of results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.UsageExportLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.

bucket_name

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.

This field is a member of oneof _bucket_name.

Type

str

report_name_prefix

An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.

This field is a member of oneof _report_name_prefix.

Type

str

class google.cloud.compute_v1.types.ValidateRegionUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionUrlMaps.Validate. See the method description for details.

project

Project ID for this request.

Type

str

region

Name of the region scoping this request.

Type

str

region_url_maps_validate_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.RegionUrlMapsValidateRequest

url_map

Name of the UrlMap resource to be validated as.

Type

str

class google.cloud.compute_v1.types.ValidateUrlMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for UrlMaps.Validate. See the method description for details.

project

Project ID for this request.

Type

str

url_map

Name of the UrlMap resource to be validated as.

Type

str

url_maps_validate_request_resource

The body resource for this request

Type

google.cloud.compute_v1.types.UrlMapsValidateRequest

class google.cloud.compute_v1.types.VmEndpointNatMappings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contain information of Nat mapping for a VM endpoint (i.e., NIC).

instance_name

Name of the VM instance which the endpoint belongs to

This field is a member of oneof _instance_name.

Type

str

interface_nat_mappings

Type

MutableSequence[google.cloud.compute_v1.types.VmEndpointNatMappingsInterfaceNatMappings]

class google.cloud.compute_v1.types.VmEndpointNatMappingsInterfaceNatMappings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contain information of Nat mapping for an interface of this endpoint.

drain_nat_ip_port_ranges

List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [“2.2.2.2:12345-12355”, “1.1.1.1:2234-2234”].

Type

MutableSequence[str]

nat_ip_port_ranges

A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [“2.2.2.2:12345-12355”, “1.1.1.1:2234-2234”].

Type

MutableSequence[str]

num_total_drain_nat_ports

Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges.

This field is a member of oneof _num_total_drain_nat_ports.

Type

int

num_total_nat_ports

Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges.

This field is a member of oneof _num_total_nat_ports.

Type

int

rule_mappings

Information about mappings provided by rules in this NAT.

Type

MutableSequence[google.cloud.compute_v1.types.VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings]

source_alias_ip_range

Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: “10.33.4.55/32”, or “192.168.5.0/24”.

This field is a member of oneof _source_alias_ip_range.

Type

str

source_virtual_ip

Primary IP of the VM for this NIC.

This field is a member of oneof _source_virtual_ip.

Type

str

class google.cloud.compute_v1.types.VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains information of NAT Mappings provided by a NAT Rule.

drain_nat_ip_port_ranges

List of all drain IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [“2.2.2.2:12345-12355”, “1.1.1.1:2234-2234”].

Type

MutableSequence[str]

nat_ip_port_ranges

A list of all IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [“2.2.2.2:12345-12355”, “1.1.1.1:2234-2234”].

Type

MutableSequence[str]

num_total_drain_nat_ports

Total number of drain ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field drain_nat_ip_port_ranges.

This field is a member of oneof _num_total_drain_nat_ports.

Type

int

num_total_nat_ports

Total number of ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field nat_ip_port_ranges.

This field is a member of oneof _num_total_nat_ports.

Type

int

rule_number

Rule number of the NAT Rule.

This field is a member of oneof _rule_number.

Type

int

class google.cloud.compute_v1.types.VmEndpointNatMappingsList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of VmEndpointNatMappings.

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

str

kind

[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

result

[Output Only] A list of Nat mapping information of VM endpoints.

Type

MutableSequence[google.cloud.compute_v1.types.VmEndpointNatMappings]

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.VpnGateway(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

gateway_ip_version

The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used. Check the GatewayIpVersion enum for the list of possible values.

This field is a member of oneof _gateway_ip_version.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Type

MutableMapping[str, str]

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.

This field is a member of oneof _name.

Type

str

network

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

This field is a member of oneof _network.

Type

str

region

[Output Only] URL of the region where the VPN gateway resides.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

stack_type

The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. Check the StackType enum for the list of possible values.

This field is a member of oneof _stack_type.

Type

str

vpn_interfaces

The list of VPN interfaces associated with this VPN gateway.

Type

MutableSequence[google.cloud.compute_v1.types.VpnGatewayVpnGatewayInterface]

class GatewayIpVersion(value)

Bases: proto.enums.Enum

The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.

Values:

UNDEFINED_GATEWAY_IP_VERSION (0):

A value indicating that the enum field is not set.

IPV4 (2254341):

Every HA-VPN gateway interface is configured with an IPv4 address.

IPV6 (2254343):

Every HA-VPN gateway interface is configured with an IPv6 address.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class StackType(value)

Bases: proto.enums.Enum

The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.

Values:

UNDEFINED_STACK_TYPE (0):

A value indicating that the enum field is not set.

IPV4_IPV6 (22197249):

Enable VPN gateway with both IPv4 and IPv6 protocols.

IPV4_ONLY (22373798):

Enable VPN gateway with only IPv4 protocol.

IPV6_ONLY (79632100):

Enable VPN gateway with only IPv6 protocol.

class google.cloud.compute_v1.types.VpnGatewayAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of VpnGateway resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.VpnGatewaysScopedList]

kind

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.VpnGatewayList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of VpnGateway resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of VpnGateway resources.

Type

MutableSequence[google.cloud.compute_v1.types.VpnGateway]

kind

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.VpnGatewayStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

vpn_connections

List of VPN connection for this VpnGateway.

Type

MutableSequence[google.cloud.compute_v1.types.VpnGatewayStatusVpnConnection]

class google.cloud.compute_v1.types.VpnGatewayStatusHighAvailabilityRequirementState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway.

state

Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. Check the State enum for the list of possible values.

This field is a member of oneof _state.

Type

str

unsatisfied_reason

Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. Check the UnsatisfiedReason enum for the list of possible values.

This field is a member of oneof _unsatisfied_reason.

Type

str

class State(value)

Bases: proto.enums.Enum

Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.

Values:

UNDEFINED_STATE (0):

A value indicating that the enum field is not set.

CONNECTION_REDUNDANCY_MET (505242907):

VPN tunnels are configured with adequate redundancy from Cloud VPN gateway to the peer VPN gateway. For both GCP-to-non-GCP and GCP-to-GCP connections, the adequate redundancy is a pre-requirement for users to get 99.99% availability on GCP side; please note that for any connection, end-to-end 99.99% availability is subject to proper configuration on the peer VPN gateway.

CONNECTION_REDUNDANCY_NOT_MET (511863311):

VPN tunnels are not configured with adequate redundancy from the Cloud VPN gateway to the peer gateway

class UnsatisfiedReason(value)

Bases: proto.enums.Enum

Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.

Values:

UNDEFINED_UNSATISFIED_REASON (0):

A value indicating that the enum field is not set.

INCOMPLETE_TUNNELS_COVERAGE (55917437):

No description available.

class google.cloud.compute_v1.types.VpnGatewayStatusTunnel(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains some information about a VPN tunnel.

local_gateway_interface

The VPN gateway interface this VPN tunnel is associated with.

This field is a member of oneof _local_gateway_interface.

Type

int

peer_gateway_interface

The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or a Google Cloud VPN gateway.

This field is a member of oneof _peer_gateway_interface.

Type

int

tunnel_url

URL reference to the VPN tunnel.

This field is a member of oneof _tunnel_url.

Type

str

class google.cloud.compute_v1.types.VpnGatewayStatusVpnConnection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be an external VPN gateway or a Google Cloud VPN gateway.

peer_external_gateway

URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

This field is a member of oneof _peer_external_gateway.

Type

str

peer_gcp_gateway

URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

This field is a member of oneof _peer_gcp_gateway.

Type

str

state

HighAvailabilityRequirementState for the VPN connection.

This field is a member of oneof _state.

Type

google.cloud.compute_v1.types.VpnGatewayStatusHighAvailabilityRequirementState

tunnels

List of VPN tunnels that are in this VPN connection.

Type

MutableSequence[google.cloud.compute_v1.types.VpnGatewayStatusTunnel]

class google.cloud.compute_v1.types.VpnGatewayVpnGatewayInterface(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A VPN gateway interface.

id

[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.

This field is a member of oneof _id.

Type

int

interconnect_attachment

URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.

This field is a member of oneof _interconnect_attachment.

Type

str

ip_address

[Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.

This field is a member of oneof _ip_address.

Type

str

ipv6_address

[Output Only] IPv6 address for this VPN interface associated with the VPN gateway. The IPv6 address must be a regional external IPv6 address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).

This field is a member of oneof _ipv6_address.

Type

str

class google.cloud.compute_v1.types.VpnGatewaysGetStatusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

result

This field is a member of oneof _result.

Type

google.cloud.compute_v1.types.VpnGatewayStatus

class google.cloud.compute_v1.types.VpnGatewaysScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

vpn_gateways

[Output Only] A list of VPN gateways contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.VpnGateway]

warning

[Output Only] Informational warning which replaces the list of addresses when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.VpnTunnel(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

description

An optional description of this resource. Provide this property when you create the resource.

This field is a member of oneof _description.

Type

str

detailed_status

[Output Only] Detailed status message for the VPN tunnel.

This field is a member of oneof _detailed_status.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

ike_version

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.

This field is a member of oneof _ike_version.

Type

int

kind

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

This field is a member of oneof _kind.

Type

str

label_fingerprint

A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.

This field is a member of oneof _label_fingerprint.

Type

str

labels

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Type

MutableMapping[str, str]

local_traffic_selector

Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.

Type

MutableSequence[str]

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.

This field is a member of oneof _name.

Type

str

peer_external_gateway

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.

This field is a member of oneof _peer_external_gateway.

Type

str

peer_external_gateway_interface

The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.

This field is a member of oneof _peer_external_gateway_interface.

Type

int

peer_gcp_gateway

URL of the peer side HA 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 Google Cloud VPN gateway.

This field is a member of oneof _peer_gcp_gateway.

Type

str

peer_ip

IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.

This field is a member of oneof _peer_ip.

Type

str

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.

This field is a member of oneof _region.

Type

str

remote_traffic_selector

Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.

Type

MutableSequence[str]

router

URL of the router resource to be used for dynamic routing.

This field is a member of oneof _router.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

shared_secret

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

This field is a member of oneof _shared_secret.

Type

str

shared_secret_hash

Hash of the shared secret.

This field is a member of oneof _shared_secret_hash.

Type

str

status

[Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

target_vpn_gateway

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.

This field is a member of oneof _target_vpn_gateway.

Type

str

vpn_gateway

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.

This field is a member of oneof _vpn_gateway.

Type

str

vpn_gateway_interface

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

This field is a member of oneof _vpn_gateway_interface.

Type

int

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Status(value)

Bases: proto.enums.Enum

[Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

ALLOCATING_RESOURCES (320922816):

Cloud VPN is in the process of allocating all required resources (specifically, a borg task).

AUTHORIZATION_ERROR (23580290):

Auth error (e.g. bad shared secret).

DEPROVISIONING (428935662):

Resources is being deallocated for the VPN tunnel.

ESTABLISHED (88852344):

Secure session is successfully established with peer VPN.

FAILED (455706685):

Tunnel creation has failed and the tunnel is not ready to be used.

FIRST_HANDSHAKE (191393000):

Successful first handshake with peer VPN.

NEGOTIATION_FAILURE (360325868):

Handshake failed.

NETWORK_ERROR (193912951):

Deprecated, replaced by NO_INCOMING_PACKETS

NO_INCOMING_PACKETS (119983216):

No incoming packets from peer

PROVISIONING (290896621):

Resource is being allocated for the VPN tunnel.

REJECTED (174130302):

Tunnel configuration was rejected, can be result of being denylisted.

STOPPED (444276141):

Tunnel is stopped due to its Forwarding Rules being deleted.

WAITING_FOR_FULL_CONFIG (41640522):

Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.

class google.cloud.compute_v1.types.VpnTunnelAggregatedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of VpnTunnelsScopedList resources.

Type

MutableMapping[str, google.cloud.compute_v1.types.VpnTunnelsScopedList]

kind

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

unreachables

[Output Only] Unreachable resources.

Type

MutableSequence[str]

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.VpnTunnelList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of VpnTunnel resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of VpnTunnel resources.

Type

MutableSequence[google.cloud.compute_v1.types.VpnTunnel]

kind

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.VpnTunnelsScopedList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

vpn_tunnels

A list of VPN tunnels contained in this scope.

Type

MutableSequence[google.cloud.compute_v1.types.VpnTunnel]

warning

Informational warning which replaces the list of addresses when the list is empty.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.WafExpressionSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

aliases

A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like “stable” is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can’t be used for more than one entity set.

Type

MutableSequence[str]

expressions

List of available expressions.

Type

MutableSequence[google.cloud.compute_v1.types.WafExpressionSetExpression]

id

Google specified expression set ID. The format should be: - E.g. XSS-20170329 required

This field is a member of oneof _id.

Type

str

class google.cloud.compute_v1.types.WafExpressionSetExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required

This field is a member of oneof _id.

Type

str

sensitivity

The sensitivity value associated with the WAF rule ID. This corresponds to the ModSecurity paranoia level, ranging from 1 to 4. 0 is reserved for opt-in only rules.

This field is a member of oneof _sensitivity.

Type

int

class google.cloud.compute_v1.types.WaitGlobalOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for GlobalOperations.Wait. See the method description for details.

operation

Name of the Operations resource to return, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

class google.cloud.compute_v1.types.WaitRegionOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for RegionOperations.Wait. See the method description for details.

operation

Name of the Operations resource to return, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

region

Name of the region for this request.

Type

str

class google.cloud.compute_v1.types.WaitZoneOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for ZoneOperations.Wait. See the method description for details.

operation

Name of the Operations resource to return, or its unique numeric identifier.

Type

str

project

Project ID for this request.

Type

str

zone

Name of the zone for this request.

Type

str

class google.cloud.compute_v1.types.Warning(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Output Only] Informational warning message.

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. Check the Code enum for the list of possible values.

This field is a member of oneof _code.

Type

str

data

[Output Only] Metadata about this warning in key: value format. For example: “data”: [ { “key”: “scope”, “value”: “zones/us-east1-d” }

Type

MutableSequence[google.cloud.compute_v1.types.Data]

message

[Output Only] A human-readable description of the warning code.

This field is a member of oneof _message.

Type

str

class Code(value)

Bases: proto.enums.Enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Values:

UNDEFINED_CODE (0):

A value indicating that the enum field is not set.

CLEANUP_FAILED (150308440):

Warning about failed cleanup of transient changes made by a failed operation.

DEPRECATED_RESOURCE_USED (391835586):

A link to a deprecated resource was created.

DEPRECATED_TYPE_USED (346526230):

When deploying and at least one of the resources has a type marked as deprecated

DISK_SIZE_LARGER_THAN_IMAGE_SIZE (369442967):

The user created a boot disk that is larger than image size.

EXPERIMENTAL_TYPE_USED (451954443):

When deploying and at least one of the resources has a type marked as experimental

EXTERNAL_API_WARNING (175546307):

Warning that is present in an external api call

FIELD_VALUE_OVERRIDEN (329669423):

Warning that value of a field has been overridden. Deprecated unused field.

INJECTED_KERNELS_DEPRECATED (417377419):

The operation involved use of an injected kernel, which is deprecated.

INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB (401542606):

A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.

LARGE_DEPLOYMENT_WARNING (481440678):

When deploying a deployment with a exceedingly large number of resources

LIST_OVERHEAD_QUOTA_EXCEED (47618117):

Resource can’t be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.

MISSING_TYPE_DEPENDENCY (344505463):

A resource depends on a missing type

NEXT_HOP_ADDRESS_NOT_ASSIGNED (324964999):

The route’s nextHopIp address is not assigned to an instance on the network.

NEXT_HOP_CANNOT_IP_FORWARD (383382887):

The route’s next hop instance cannot ip forward.

NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE (146748434):

The route’s nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.

NEXT_HOP_INSTANCE_NOT_FOUND (464250446):

The route’s nextHopInstance URL refers to an instance that does not exist.

NEXT_HOP_INSTANCE_NOT_ON_NETWORK (243758146):

The route’s nextHopInstance URL refers to an instance that is not on the same network as the route.

NEXT_HOP_NOT_RUNNING (417081265):

The route’s next hop instance does not have a status of RUNNING.

NOT_CRITICAL_ERROR (105763924):

Error which is not critical. We decided to continue the process despite the mentioned error.

NO_RESULTS_ON_PAGE (30036744):

No results are present on a particular list page.

PARTIAL_SUCCESS (39966469):

Success is reported, but some results may be missing due to errors

REQUIRED_TOS_AGREEMENT (3745539):

The user attempted to use a resource that requires a TOS they have not accepted.

RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING (496728641):

Warning that a resource is in use.

RESOURCE_NOT_DELETED (168598460):

One or more of the resources set to auto-delete could not be deleted because they were in use.

SCHEMA_VALIDATION_IGNORED (275245642):

When a resource schema validation is ignored.

SINGLE_INSTANCE_PROPERTY_TEMPLATE (268305617):

Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.

UNDECLARED_PROPERTIES (390513439):

When undeclared properties in the schema are present

UNREACHABLE (13328052):

A given scope cannot be reached.

class google.cloud.compute_v1.types.Warnings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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. Check the Code enum for the list of possible values.

This field is a member of oneof _code.

Type

str

data

[Output Only] Metadata about this warning in key: value format. For example: “data”: [ { “key”: “scope”, “value”: “zones/us-east1-d” }

Type

MutableSequence[google.cloud.compute_v1.types.Data]

message

[Output Only] A human-readable description of the warning code.

This field is a member of oneof _message.

Type

str

class Code(value)

Bases: proto.enums.Enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Values:

UNDEFINED_CODE (0):

A value indicating that the enum field is not set.

CLEANUP_FAILED (150308440):

Warning about failed cleanup of transient changes made by a failed operation.

DEPRECATED_RESOURCE_USED (391835586):

A link to a deprecated resource was created.

DEPRECATED_TYPE_USED (346526230):

When deploying and at least one of the resources has a type marked as deprecated

DISK_SIZE_LARGER_THAN_IMAGE_SIZE (369442967):

The user created a boot disk that is larger than image size.

EXPERIMENTAL_TYPE_USED (451954443):

When deploying and at least one of the resources has a type marked as experimental

EXTERNAL_API_WARNING (175546307):

Warning that is present in an external api call

FIELD_VALUE_OVERRIDEN (329669423):

Warning that value of a field has been overridden. Deprecated unused field.

INJECTED_KERNELS_DEPRECATED (417377419):

The operation involved use of an injected kernel, which is deprecated.

INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB (401542606):

A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.

LARGE_DEPLOYMENT_WARNING (481440678):

When deploying a deployment with a exceedingly large number of resources

LIST_OVERHEAD_QUOTA_EXCEED (47618117):

Resource can’t be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.

MISSING_TYPE_DEPENDENCY (344505463):

A resource depends on a missing type

NEXT_HOP_ADDRESS_NOT_ASSIGNED (324964999):

The route’s nextHopIp address is not assigned to an instance on the network.

NEXT_HOP_CANNOT_IP_FORWARD (383382887):

The route’s next hop instance cannot ip forward.

NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE (146748434):

The route’s nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.

NEXT_HOP_INSTANCE_NOT_FOUND (464250446):

The route’s nextHopInstance URL refers to an instance that does not exist.

NEXT_HOP_INSTANCE_NOT_ON_NETWORK (243758146):

The route’s nextHopInstance URL refers to an instance that is not on the same network as the route.

NEXT_HOP_NOT_RUNNING (417081265):

The route’s next hop instance does not have a status of RUNNING.

NOT_CRITICAL_ERROR (105763924):

Error which is not critical. We decided to continue the process despite the mentioned error.

NO_RESULTS_ON_PAGE (30036744):

No results are present on a particular list page.

PARTIAL_SUCCESS (39966469):

Success is reported, but some results may be missing due to errors

REQUIRED_TOS_AGREEMENT (3745539):

The user attempted to use a resource that requires a TOS they have not accepted.

RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING (496728641):

Warning that a resource is in use.

RESOURCE_NOT_DELETED (168598460):

One or more of the resources set to auto-delete could not be deleted because they were in use.

SCHEMA_VALIDATION_IGNORED (275245642):

When a resource schema validation is ignored.

SINGLE_INSTANCE_PROPERTY_TEMPLATE (268305617):

Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.

UNDECLARED_PROPERTIES (390513439):

When undeclared properties in the schema are present

UNREACHABLE (13328052):

A given scope cannot be reached.

class google.cloud.compute_v1.types.WeightedBackendService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService

backend_service

The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.

This field is a member of oneof _backend_service.

Type

str

header_action

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

This field is a member of oneof _header_action.

Type

google.cloud.compute_v1.types.HttpHeaderAction

weight

Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user’s request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service’s session affinity policy. Don’t configure session affinity if you’re using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000.

This field is a member of oneof _weight.

Type

int

class google.cloud.compute_v1.types.WithdrawPublicAdvertisedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicAdvertisedPrefixes.Withdraw. See the method description for details.

project

Project ID for this request.

Type

str

public_advertised_prefix

The name of the public advertised prefix. It should comply with RFC1035.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.WithdrawPublicDelegatedPrefixeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for PublicDelegatedPrefixes.Withdraw. See the method description for details.

project

Project ID for this request.

Type

str

public_delegated_prefix

The name of the public delegated prefix. It should comply with RFC1035.

Type

str

region

The name of the region where the public delegated prefix is located. It should comply with RFC1035.

Type

str

request_id

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).

This field is a member of oneof _request_id.

Type

str

class google.cloud.compute_v1.types.XpnHostList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

[Output Only] A list of shared VPC host project URLs.

Type

MutableSequence[google.cloud.compute_v1.types.Project]

kind

[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.XpnResourceId(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Service resource (a.k.a service project) ID.

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).

This field is a member of oneof _id.

Type

str

type_

The type of the service resource. Check the Type enum for the list of possible values.

This field is a member of oneof _type.

Type

str

class Type(value)

Bases: proto.enums.Enum

The type of the service resource.

Values:

UNDEFINED_TYPE (0):

A value indicating that the enum field is not set.

PROJECT (408671993):

No description available.

XPN_RESOURCE_TYPE_UNSPECIFIED (151607034):

No description available.

class google.cloud.compute_v1.types.Zone(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-b is located in the us-east1 region. For more information, read Regions and Zones.

available_cpu_platforms

[Output Only] Available cpu/platform selections for the zone.

Type

MutableSequence[str]

creation_timestamp

[Output Only] Creation timestamp in RFC3339 text format.

This field is a member of oneof _creation_timestamp.

Type

str

deprecated

[Output Only] The deprecation status associated with this zone.

This field is a member of oneof _deprecated.

Type

google.cloud.compute_v1.types.DeprecationStatus

description

[Output Only] Textual description of the resource.

This field is a member of oneof _description.

Type

str

id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

This field is a member of oneof _id.

Type

int

kind

[Output Only] Type of the resource. Always compute#zone for zones.

This field is a member of oneof _kind.

Type

str

name

[Output Only] Name of the resource.

This field is a member of oneof _name.

Type

str

region

[Output Only] Full URL reference to the region which hosts the zone.

This field is a member of oneof _region.

Type

str

self_link

[Output Only] Server-defined URL for the resource.

This field is a member of oneof _self_link.

Type

str

status

[Output Only] Status of the zone, either UP or DOWN. Check the Status enum for the list of possible values.

This field is a member of oneof _status.

Type

str

supports_pzs

[Output Only] Reserved for future use.

This field is a member of oneof _supports_pzs.

Type

bool

class Status(value)

Bases: proto.enums.Enum

[Output Only] Status of the zone, either UP or DOWN.

Values:

UNDEFINED_STATUS (0):

A value indicating that the enum field is not set.

DOWN (2104482):

No description available.

UP (2715):

No description available.

class google.cloud.compute_v1.types.ZoneList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a list of zone resources.

id

[Output Only] Unique identifier for the resource; defined by the server.

This field is a member of oneof _id.

Type

str

items

A list of Zone resources.

Type

MutableSequence[google.cloud.compute_v1.types.Zone]

kind

Type of resource.

This field is a member of oneof _kind.

Type

str

next_page_token

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

This field is a member of oneof _next_page_token.

Type

str

self_link

[Output Only] Server-defined URL for this resource.

This field is a member of oneof _self_link.

Type

str

warning

[Output Only] Informational warning message.

This field is a member of oneof _warning.

Type

google.cloud.compute_v1.types.Warning

class google.cloud.compute_v1.types.ZoneSetLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

label_fingerprint

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.

This field is a member of oneof _label_fingerprint.

Type

str

labels

The labels to set for this resource.

Type

MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.compute_v1.types.ZoneSetPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

bindings

Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use ‘policy’ to specify bindings.

Type

MutableSequence[google.cloud.compute_v1.types.Binding]

etag

Flatten Policy to create a backward compatible wire-format. Deprecated. Use ‘policy’ to specify the etag.

This field is a member of oneof _etag.

Type

str

policy

REQUIRED: The complete policy to be applied to the ‘resource’. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

This field is a member of oneof _policy.

Type

google.cloud.compute_v1.types.Policy