Package com.google.cloud.beyondcorp.clientconnectorservices.v1 (0.5.0)

A client to BeyondCorp API

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

ClientConnectorServicesServiceClient

Service Description: API Overview:

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

Data Model:

The ClientConnectorServicesService exposes the following resources:

Client Connector Services, named as follows: projects/{project_id}/locations/{location_id}/client_connector_services/{client_connector_service_id}.

Sample for ClientConnectorServicesServiceClient:


 // 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 (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ClientConnectorServiceName name =
       ClientConnectorServiceName.of("[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]");
   ClientConnectorService response =
       clientConnectorServicesServiceClient.getClientConnectorService(name);
 }

Classes

ClientConnectorService

Message describing ClientConnectorService object.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService

ClientConnectorService.Builder

Message describing ClientConnectorService object.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService

ClientConnectorService.Egress

The details of the egress info. One of the following options should be set.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Egress

ClientConnectorService.Egress.Builder

The details of the egress info. One of the following options should be set.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Egress

ClientConnectorService.Egress.PeeredVpc

The peered VPC owned by the consumer project.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Egress.PeeredVpc

ClientConnectorService.Egress.PeeredVpc.Builder

The peered VPC owned by the consumer project.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Egress.PeeredVpc

ClientConnectorService.Ingress

Settings of how to connect to the ClientGateway. One of the following options should be set.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Ingress

ClientConnectorService.Ingress.Builder

Settings of how to connect to the ClientGateway. One of the following options should be set.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Ingress

ClientConnectorService.Ingress.Config

The basic ingress config for ClientGateways.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Ingress.Config

ClientConnectorService.Ingress.Config.Builder

The basic ingress config for ClientGateways.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Ingress.Config

ClientConnectorService.Ingress.Config.DestinationRoute

The setting used to configure ClientGateways. It is adding routes to the client's routing table after the connection is established.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Ingress.Config.DestinationRoute

ClientConnectorService.Ingress.Config.DestinationRoute.Builder

The setting used to configure ClientGateways. It is adding routes to the client's routing table after the connection is established.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService.Ingress.Config.DestinationRoute

ClientConnectorServiceName.Builder

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

ClientConnectorServiceOperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServiceOperationMetadata

ClientConnectorServiceOperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorServiceOperationMetadata

ClientConnectorServicesServiceClient

Service Description: API Overview:

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

Data Model:

The ClientConnectorServicesService exposes the following resources:

Client Connector Services, named as follows: projects/{project_id}/locations/{location_id}/client_connector_services/{client_connector_service_id}.

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 (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ClientConnectorServiceName name =
       ClientConnectorServiceName.of("[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]");
   ClientConnectorService response =
       clientConnectorServicesServiceClient.getClientConnectorService(name);
 }

Note: close() needs to be called on the ClientConnectorServicesServiceClient 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:

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.
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.
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 ClientConnectorServicesServiceSettings 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
 ClientConnectorServicesServiceSettings clientConnectorServicesServiceSettings =
     ClientConnectorServicesServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create(clientConnectorServicesServiceSettings);

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
 ClientConnectorServicesServiceSettings clientConnectorServicesServiceSettings =
     ClientConnectorServicesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create(clientConnectorServicesServiceSettings);

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

ClientConnectorServicesServiceClient.ListClientConnectorServicesFixedSizeCollection

ClientConnectorServicesServiceClient.ListClientConnectorServicesPage

ClientConnectorServicesServiceClient.ListClientConnectorServicesPagedResponse