Package com.google.cloud.beyondcorp.appconnections.v1 (0.8.0)

A client to BeyondCorp API

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

AppConnectionsServiceClient

Service Description: API Overview:

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

Data Model:

The AppConnectionsService exposes the following resources:

AppConnections, named as follows: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}.

The AppConnectionsService service provides methods to manage (create/read/update/delete) BeyondCorp AppConnections.

Sample for AppConnectionsServiceClient:


 // 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 (AppConnectionsServiceClient appConnectionsServiceClient =
     AppConnectionsServiceClient.create()) {
   AppConnectionName name = AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]");
   AppConnection response = appConnectionsServiceClient.getAppConnection(name);
 }

Classes

AppConnection

A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection.

Protobuf type google.cloud.beyondcorp.appconnections.v1.AppConnection

AppConnection.ApplicationEndpoint

ApplicationEndpoint represents a remote application endpoint.

Protobuf type google.cloud.beyondcorp.appconnections.v1.AppConnection.ApplicationEndpoint

AppConnection.ApplicationEndpoint.Builder

ApplicationEndpoint represents a remote application endpoint.

Protobuf type google.cloud.beyondcorp.appconnections.v1.AppConnection.ApplicationEndpoint

AppConnection.Builder

Protobuf type google.cloud.beyondcorp.appconnections.v1.AppConnection

AppConnection.Gateway

Gateway represents a user facing component that serves as an entrance to enable connectivity.

Protobuf type google.cloud.beyondcorp.appconnections.v1.AppConnection.Gateway

AppConnection.Gateway.Builder

Gateway represents a user facing component that serves as an entrance to enable connectivity.

Protobuf type google.cloud.beyondcorp.appconnections.v1.AppConnection.Gateway

AppConnectionName

AppConnectionName.Builder

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

AppConnectionOperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata

AppConnectionOperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata

AppConnectionsServiceClient

Service Description: API Overview:

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

Data Model:

The AppConnectionsService exposes the following resources:

AppConnections, named as follows: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}.

The AppConnectionsService service provides methods to manage (create/read/update/delete) BeyondCorp AppConnections.

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 (AppConnectionsServiceClient appConnectionsServiceClient =
     AppConnectionsServiceClient.create()) {
   AppConnectionName name = AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]");
   AppConnection response = appConnectionsServiceClient.getAppConnection(name);
 }

Note: close() needs to be called on the AppConnectionsServiceClient 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 AppConnectionsServiceSettings 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
 AppConnectionsServiceSettings appConnectionsServiceSettings =
     AppConnectionsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AppConnectionsServiceClient appConnectionsServiceClient =
     AppConnectionsServiceClient.create(appConnectionsServiceSettings);

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
 AppConnectionsServiceSettings appConnectionsServiceSettings =
     AppConnectionsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AppConnectionsServiceClient appConnectionsServiceClient =
     AppConnectionsServiceClient.create(appConnectionsServiceSettings);

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

AppConnectionsServiceClient.ListAppConnectionsFixedSizeCollection

AppConnectionsServiceClient.ListAppConnectionsPage

AppConnectionsServiceClient.ListAppConnectionsPagedResponse

AppConnectionsServiceClient.ListLocationsFixedSizeCollection

AppConnectionsServiceClient.ListLocationsPage

AppConnectionsServiceClient.ListLocationsPagedResponse