Package com.google.cloud.vpcaccess.v1 (2.30.0)

A client to Serverless VPC Access API

The interfaces provided are listed below, along with usage samples.

VpcAccessServiceClient

Service Description: Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

Sample for VpcAccessServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) {
   ConnectorName name = ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]");
   Connector response = vpcAccessServiceClient.getConnector(name);
 }

Classes

Connector

Definition of a Serverless VPC Access connector.

Protobuf type google.cloud.vpcaccess.v1.Connector

Connector.Builder

Definition of a Serverless VPC Access connector.

Protobuf type google.cloud.vpcaccess.v1.Connector

Connector.Subnet

The subnet in which to house the connector

Protobuf type google.cloud.vpcaccess.v1.Connector.Subnet

Connector.Subnet.Builder

The subnet in which to house the connector

Protobuf type google.cloud.vpcaccess.v1.Connector.Subnet

ConnectorName

ConnectorName.Builder

Builder for projects/{project}/locations/{location}/connectors/{connector}.

CreateConnectorRequest

Request for creating a Serverless VPC Access connector.

Protobuf type google.cloud.vpcaccess.v1.CreateConnectorRequest

CreateConnectorRequest.Builder

Request for creating a Serverless VPC Access connector.

Protobuf type google.cloud.vpcaccess.v1.CreateConnectorRequest

DeleteConnectorRequest

Request for deleting a Serverless VPC Access connector.

Protobuf type google.cloud.vpcaccess.v1.DeleteConnectorRequest

DeleteConnectorRequest.Builder

Request for deleting a Serverless VPC Access connector.

Protobuf type google.cloud.vpcaccess.v1.DeleteConnectorRequest

GetConnectorRequest

Request for getting a Serverless VPC Access connector.

Protobuf type google.cloud.vpcaccess.v1.GetConnectorRequest

GetConnectorRequest.Builder

Request for getting a Serverless VPC Access connector.

Protobuf type google.cloud.vpcaccess.v1.GetConnectorRequest

ListConnectorsRequest

Request for listing Serverless VPC Access connectors in a location.

Protobuf type google.cloud.vpcaccess.v1.ListConnectorsRequest

ListConnectorsRequest.Builder

Request for listing Serverless VPC Access connectors in a location.

Protobuf type google.cloud.vpcaccess.v1.ListConnectorsRequest

ListConnectorsResponse

Response for listing Serverless VPC Access connectors.

Protobuf type google.cloud.vpcaccess.v1.ListConnectorsResponse

ListConnectorsResponse.Builder

Response for listing Serverless VPC Access connectors.

Protobuf type google.cloud.vpcaccess.v1.ListConnectorsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

OperationMetadata

Metadata for google.longrunning.Operation.

Protobuf type google.cloud.vpcaccess.v1.OperationMetadata

OperationMetadata.Builder

Metadata for google.longrunning.Operation.

Protobuf type google.cloud.vpcaccess.v1.OperationMetadata

VpcAccessProto

VpcAccessServiceClient

Service Description: Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) {
   ConnectorName name = ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]");
   Connector response = vpcAccessServiceClient.getConnector(name);
 }

Note: close() needs to be called on the VpcAccessServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of VpcAccessServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VpcAccessServiceSettings vpcAccessServiceSettings =
     VpcAccessServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VpcAccessServiceClient vpcAccessServiceClient =
     VpcAccessServiceClient.create(vpcAccessServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VpcAccessServiceSettings vpcAccessServiceSettings =
     VpcAccessServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VpcAccessServiceClient vpcAccessServiceClient =
     VpcAccessServiceClient.create(vpcAccessServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VpcAccessServiceSettings vpcAccessServiceSettings =
     VpcAccessServiceSettings.newHttpJsonBuilder().build();
 VpcAccessServiceClient vpcAccessServiceClient =
     VpcAccessServiceClient.create(vpcAccessServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

VpcAccessServiceClient.ListConnectorsFixedSizeCollection

VpcAccessServiceClient.ListConnectorsPage

VpcAccessServiceClient.ListConnectorsPagedResponse

VpcAccessServiceClient.ListLocationsFixedSizeCollection

VpcAccessServiceClient.ListLocationsPage

VpcAccessServiceClient.ListLocationsPagedResponse

VpcAccessServiceGrpc

Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

VpcAccessServiceGrpc.VpcAccessServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service VpcAccessService.

Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

VpcAccessServiceGrpc.VpcAccessServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service VpcAccessService.

Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

VpcAccessServiceGrpc.VpcAccessServiceImplBase

Base class for the server implementation of the service VpcAccessService.

Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

VpcAccessServiceGrpc.VpcAccessServiceStub

A stub to allow clients to do asynchronous rpc calls to service VpcAccessService.

Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

VpcAccessServiceSettings

Settings class to configure an instance of VpcAccessServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (vpcaccess.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getConnector to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VpcAccessServiceSettings.Builder vpcAccessServiceSettingsBuilder =
     VpcAccessServiceSettings.newBuilder();
 vpcAccessServiceSettingsBuilder
     .getConnectorSettings()
     .setRetrySettings(
         vpcAccessServiceSettingsBuilder
             .getConnectorSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VpcAccessServiceSettings vpcAccessServiceSettings = vpcAccessServiceSettingsBuilder.build();

VpcAccessServiceSettings.Builder

Builder for VpcAccessServiceSettings.

Interfaces

Connector.SubnetOrBuilder

ConnectorOrBuilder

CreateConnectorRequestOrBuilder

DeleteConnectorRequestOrBuilder

GetConnectorRequestOrBuilder

ListConnectorsRequestOrBuilder

ListConnectorsResponseOrBuilder

OperationMetadataOrBuilder

VpcAccessServiceGrpc.AsyncService

Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

Enums

Connector.State

State of a connector.

Protobuf enum google.cloud.vpcaccess.v1.Connector.State