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

A client to BeyondCorp API

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

AppConnectorsServiceClient

Service Description: API Overview:

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

Data Model:

The AppConnectorsService exposes the following resource:

AppConnectors, named as follows: projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}.

The AppConnectorsService provides methods to manage (create/read/update/delete) BeyondCorp AppConnectors.

Sample for AppConnectorsServiceClient:


 // 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 (AppConnectorsServiceClient appConnectorsServiceClient =
     AppConnectorsServiceClient.create()) {
   AppConnectorName name = AppConnectorName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTOR]");
   AppConnector response = appConnectorsServiceClient.getAppConnector(name);
 }

Classes

AppConnector

A BeyondCorp connector resource that represents an application facing component deployed proximal to and with direct access to the application instances. It is used to establish connectivity between the remote enterprise environment and GCP. It initiates connections to the applications and can proxy the data from users over the connection.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnector

AppConnector.Builder

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnector

AppConnector.PrincipalInfo

PrincipalInfo represents an Identity oneof.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnector.PrincipalInfo

AppConnector.PrincipalInfo.Builder

PrincipalInfo represents an Identity oneof.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnector.PrincipalInfo

AppConnector.PrincipalInfo.ServiceAccount

ServiceAccount represents a GCP service account.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnector.PrincipalInfo.ServiceAccount

AppConnector.PrincipalInfo.ServiceAccount.Builder

ServiceAccount represents a GCP service account.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnector.PrincipalInfo.ServiceAccount

AppConnectorInstanceConfig

AppConnectorInstanceConfig defines the instance config of a AppConnector.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnectorInstanceConfig

AppConnectorInstanceConfig.Builder

AppConnectorInstanceConfig defines the instance config of a AppConnector.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnectorInstanceConfig

AppConnectorInstanceConfigProto

AppConnectorName

AppConnectorName.Builder

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

AppConnectorOperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnectorOperationMetadata

AppConnectorOperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.beyondcorp.appconnectors.v1.AppConnectorOperationMetadata

AppConnectorsServiceClient

Service Description: API Overview:

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

Data Model:

The AppConnectorsService exposes the following resource:

AppConnectors, named as follows: projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}.

The AppConnectorsService provides methods to manage (create/read/update/delete) BeyondCorp AppConnectors.

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 (AppConnectorsServiceClient appConnectorsServiceClient =
     AppConnectorsServiceClient.create()) {
   AppConnectorName name = AppConnectorName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTOR]");
   AppConnector response = appConnectorsServiceClient.getAppConnector(name);
 }

Note: close() needs to be called on the AppConnectorsServiceClient 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 AppConnectorsServiceSettings 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
 AppConnectorsServiceSettings appConnectorsServiceSettings =
     AppConnectorsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AppConnectorsServiceClient appConnectorsServiceClient =
     AppConnectorsServiceClient.create(appConnectorsServiceSettings);

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
 AppConnectorsServiceSettings appConnectorsServiceSettings =
     AppConnectorsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AppConnectorsServiceClient appConnectorsServiceClient =
     AppConnectorsServiceClient.create(appConnectorsServiceSettings);

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

AppConnectorsServiceClient.ListAppConnectorsFixedSizeCollection

AppConnectorsServiceClient.ListAppConnectorsPage

AppConnectorsServiceClient.ListAppConnectorsPagedResponse