- 0.51.0 (latest)
- 0.50.0
- 0.49.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.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
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.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
AppConnectionsServiceClient.ResolveAppConnectionsFixedSizeCollection
AppConnectionsServiceClient.ResolveAppConnectionsPage
AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse
AppConnectionsServiceGrpc
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.
AppConnectionsServiceGrpc.AppConnectionsServiceBlockingStub
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.
AppConnectionsServiceGrpc.AppConnectionsServiceFutureStub
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.
AppConnectionsServiceGrpc.AppConnectionsServiceImplBase
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.
AppConnectionsServiceGrpc.AppConnectionsServiceStub
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.
AppConnectionsServiceProto
AppConnectionsServiceSettings
Settings class to configure an instance of AppConnectionsServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (beyondcorp.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 getAppConnection 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
AppConnectionsServiceSettings.Builder appConnectionsServiceSettingsBuilder =
AppConnectionsServiceSettings.newBuilder();
appConnectionsServiceSettingsBuilder
.getAppConnectionSettings()
.setRetrySettings(
appConnectionsServiceSettingsBuilder
.getAppConnectionSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AppConnectionsServiceSettings appConnectionsServiceSettings =
appConnectionsServiceSettingsBuilder.build();
AppConnectionsServiceSettings.Builder
Builder for AppConnectionsServiceSettings.
AppConnectorName
AppConnectorName.Builder
Builder for projects/{project}/locations/{location}/appConnectors/{app_connector}.
CreateAppConnectionRequest
Request message for BeyondCorp.CreateAppConnection.
Protobuf type google.cloud.beyondcorp.appconnections.v1.CreateAppConnectionRequest
CreateAppConnectionRequest.Builder
Request message for BeyondCorp.CreateAppConnection.
Protobuf type google.cloud.beyondcorp.appconnections.v1.CreateAppConnectionRequest
DeleteAppConnectionRequest
Request message for BeyondCorp.DeleteAppConnection.
Protobuf type google.cloud.beyondcorp.appconnections.v1.DeleteAppConnectionRequest
DeleteAppConnectionRequest.Builder
Request message for BeyondCorp.DeleteAppConnection.
Protobuf type google.cloud.beyondcorp.appconnections.v1.DeleteAppConnectionRequest
GetAppConnectionRequest
Request message for BeyondCorp.GetAppConnection.
Protobuf type google.cloud.beyondcorp.appconnections.v1.GetAppConnectionRequest
GetAppConnectionRequest.Builder
Request message for BeyondCorp.GetAppConnection.
Protobuf type google.cloud.beyondcorp.appconnections.v1.GetAppConnectionRequest
ListAppConnectionsRequest
Request message for BeyondCorp.ListAppConnections.
Protobuf type google.cloud.beyondcorp.appconnections.v1.ListAppConnectionsRequest
ListAppConnectionsRequest.Builder
Request message for BeyondCorp.ListAppConnections.
Protobuf type google.cloud.beyondcorp.appconnections.v1.ListAppConnectionsRequest
ListAppConnectionsResponse
Response message for BeyondCorp.ListAppConnections.
Protobuf type google.cloud.beyondcorp.appconnections.v1.ListAppConnectionsResponse
ListAppConnectionsResponse.Builder
Response message for BeyondCorp.ListAppConnections.
Protobuf type google.cloud.beyondcorp.appconnections.v1.ListAppConnectionsResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
ResolveAppConnectionsRequest
Request message for BeyondCorp.ResolveAppConnections.
Protobuf type google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsRequest
ResolveAppConnectionsRequest.Builder
Request message for BeyondCorp.ResolveAppConnections.
Protobuf type google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsRequest
ResolveAppConnectionsResponse
Response message for BeyondCorp.ResolveAppConnections.
Protobuf type google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse
ResolveAppConnectionsResponse.AppConnectionDetails
Details of the AppConnection.
Protobuf type
google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails
ResolveAppConnectionsResponse.AppConnectionDetails.Builder
Details of the AppConnection.
Protobuf type
google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails
ResolveAppConnectionsResponse.Builder
Response message for BeyondCorp.ResolveAppConnections.
Protobuf type google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse
UpdateAppConnectionRequest
Request message for BeyondCorp.UpdateAppConnection.
Protobuf type google.cloud.beyondcorp.appconnections.v1.UpdateAppConnectionRequest
UpdateAppConnectionRequest.Builder
Request message for BeyondCorp.UpdateAppConnection.
Protobuf type google.cloud.beyondcorp.appconnections.v1.UpdateAppConnectionRequest
Interfaces
AppConnection.ApplicationEndpointOrBuilder
AppConnection.GatewayOrBuilder
AppConnectionOperationMetadataOrBuilder
AppConnectionOrBuilder
CreateAppConnectionRequestOrBuilder
DeleteAppConnectionRequestOrBuilder
GetAppConnectionRequestOrBuilder
ListAppConnectionsRequestOrBuilder
ListAppConnectionsResponseOrBuilder
ResolveAppConnectionsRequestOrBuilder
ResolveAppConnectionsResponse.AppConnectionDetailsOrBuilder
ResolveAppConnectionsResponseOrBuilder
UpdateAppConnectionRequestOrBuilder
Enums
AppConnection.Gateway.Type
Enum listing possible gateway hosting options.
Protobuf enum google.cloud.beyondcorp.appconnections.v1.AppConnection.Gateway.Type
AppConnection.State
Represents the different states of a AppConnection.
Protobuf enum google.cloud.beyondcorp.appconnections.v1.AppConnection.State
AppConnection.Type
Enum containing list of all possible network connectivity options supported by BeyondCorp AppConnection.
Protobuf enum google.cloud.beyondcorp.appconnections.v1.AppConnection.Type