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 Vpcaccess v1 API

class google.cloud.vpcaccess_v1.types.Connector(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Definition of a Serverless VPC Access connector.

name

The resource name in the format projects/*/locations/*/connectors/*.

Type

str

network

Name of a VPC network.

Type

str

ip_cidr_range

The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.

Type

str

state

Output only. State of the VPC access connector.

Type

google.cloud.vpcaccess_v1.types.Connector.State

min_throughput

Minimum throughput of the connector in Mbps. Default and min is 200.

Type

int

max_throughput

Maximum throughput of the connector in Mbps. Default is 300, max is 1000.

Type

int

connected_projects

Output only. List of projects using the connector.

Type

MutableSequence[str]

subnet

The subnet in which to house the VPC Access Connector.

Type

google.cloud.vpcaccess_v1.types.Connector.Subnet

machine_type

Machine type of VM Instance underlying connector. Default is e2-micro

Type

str

min_instances

Minimum value of instances in autoscaling group underlying the connector.

Type

int

max_instances

Maximum value of instances in autoscaling group underlying the connector.

Type

int

class State(value)

Bases: proto.enums.Enum

State of a connector.

Values:

STATE_UNSPECIFIED (0):

Invalid state.

READY (1):

Connector is deployed and ready to receive traffic.

CREATING (2):

An Insert operation is in progress. Transient condition.

DELETING (3):

A Delete operation is in progress. Transient condition.

ERROR (4):

Connector is in a bad state, manual deletion recommended.

UPDATING (5):

The connector is being updated.

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

Bases: proto.message.Message

The subnet in which to house the connector

name

Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}

Type

str

project_id

Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.

Type

str

class google.cloud.vpcaccess_v1.types.CreateConnectorRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for creating a Serverless VPC Access connector.

parent

Required. The project and location in which the configuration should be created, specified in the format projects/*/locations/*.

Type

str

connector_id

Required. The ID to use for this connector.

Type

str

connector

Required. Resource to create.

Type

google.cloud.vpcaccess_v1.types.Connector

class google.cloud.vpcaccess_v1.types.DeleteConnectorRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for deleting a Serverless VPC Access connector.

name

Required. Name of a Serverless VPC Access connector to delete.

Type

str

class google.cloud.vpcaccess_v1.types.GetConnectorRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for getting a Serverless VPC Access connector.

name

Required. Name of a Serverless VPC Access connector to get.

Type

str

class google.cloud.vpcaccess_v1.types.ListConnectorsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for listing Serverless VPC Access connectors in a location.

parent

Required. The project and location from which the routes should be listed.

Type

str

page_size

Maximum number of functions to return per call.

Type

int

page_token

Continuation token.

Type

str

class google.cloud.vpcaccess_v1.types.ListConnectorsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for listing Serverless VPC Access connectors.

connectors

List of Serverless VPC Access connectors.

Type

MutableSequence[google.cloud.vpcaccess_v1.types.Connector]

next_page_token

Continuation token.

Type

str

class google.cloud.vpcaccess_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata for google.longrunning.Operation.

method

Output only. Method that initiated the operation e.g. google.cloud.vpcaccess.v1.Connectors.CreateConnector.

Type

str

create_time

Output only. Time when the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Time when the operation completed.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Output only. Name of the resource that this operation is acting on e.g. projects/my-project/locations/us-central1/connectors/v1.

Type

str