Package com.google.cloud.beyondcorp.clientgateways.v1 (0.17.0)

A client to BeyondCorp API

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

ClientGatewaysServiceClient

Service Description: API Overview:

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

Data Model:

The ClientGatewaysService exposes the following resources:

Client Gateways, named as follows: projects/{project_id}/locations/{location_id}/clientGateways/{client_gateway_id}.

Sample for ClientGatewaysServiceClient:


 // 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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ClientGatewayName name = ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]");
   ClientGateway response = clientGatewaysServiceClient.getClientGateway(name);
 }

Classes

ClientGateway

Message describing ClientGateway object.

Protobuf type google.cloud.beyondcorp.clientgateways.v1.ClientGateway

ClientGateway.Builder

Message describing ClientGateway object.

Protobuf type google.cloud.beyondcorp.clientgateways.v1.ClientGateway

ClientGatewayName.Builder

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

ClientGatewayOperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.beyondcorp.clientgateways.v1.ClientGatewayOperationMetadata

ClientGatewayOperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.beyondcorp.clientgateways.v1.ClientGatewayOperationMetadata

ClientGatewaysServiceClient

Service Description: API Overview:

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

Data Model:

The ClientGatewaysService exposes the following resources:

Client Gateways, named as follows: projects/{project_id}/locations/{location_id}/clientGateways/{client_gateway_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 (ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create()) {
   ClientGatewayName name = ClientGatewayName.of("[PROJECT]", "[LOCATION]", "[CLIENT_GATEWAY]");
   ClientGateway response = clientGatewaysServiceClient.getClientGateway(name);
 }

Note: close() needs to be called on the ClientGatewaysServiceClient 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 ClientGatewaysServiceSettings 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
 ClientGatewaysServiceSettings clientGatewaysServiceSettings =
     ClientGatewaysServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create(clientGatewaysServiceSettings);

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
 ClientGatewaysServiceSettings clientGatewaysServiceSettings =
     ClientGatewaysServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ClientGatewaysServiceClient clientGatewaysServiceClient =
     ClientGatewaysServiceClient.create(clientGatewaysServiceSettings);

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

ClientGatewaysServiceClient.ListClientGatewaysFixedSizeCollection

ClientGatewaysServiceClient.ListClientGatewaysPage

ClientGatewaysServiceClient.ListClientGatewaysPagedResponse