- 0.49.0 (latest)
- 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.
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
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
ClientGatewaysServiceClient.ListLocationsFixedSizeCollection
ClientGatewaysServiceClient.ListLocationsPage
ClientGatewaysServiceClient.ListLocationsPagedResponse
ClientGatewaysServiceGrpc
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}
.
ClientGatewaysServiceGrpc.ClientGatewaysServiceBlockingStub
A stub to allow clients to do synchronous rpc calls to service ClientGatewaysService.
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}
.
ClientGatewaysServiceGrpc.ClientGatewaysServiceFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service ClientGatewaysService.
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}
.
ClientGatewaysServiceGrpc.ClientGatewaysServiceImplBase
Base class for the server implementation of the service ClientGatewaysService.
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}
.
ClientGatewaysServiceGrpc.ClientGatewaysServiceStub
A stub to allow clients to do asynchronous rpc calls to service ClientGatewaysService.
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}
.
ClientGatewaysServiceProto
ClientGatewaysServiceSettings
Settings class to configure an instance of ClientGatewaysServiceClient.
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 getClientGateway 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
ClientGatewaysServiceSettings.Builder clientGatewaysServiceSettingsBuilder =
ClientGatewaysServiceSettings.newBuilder();
clientGatewaysServiceSettingsBuilder
.getClientGatewaySettings()
.setRetrySettings(
clientGatewaysServiceSettingsBuilder
.getClientGatewaySettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ClientGatewaysServiceSettings clientGatewaysServiceSettings =
clientGatewaysServiceSettingsBuilder.build();
ClientGatewaysServiceSettings.Builder
Builder for ClientGatewaysServiceSettings.
CreateClientGatewayRequest
Message for creating a ClientGateway.
Protobuf type google.cloud.beyondcorp.clientgateways.v1.CreateClientGatewayRequest
CreateClientGatewayRequest.Builder
Message for creating a ClientGateway.
Protobuf type google.cloud.beyondcorp.clientgateways.v1.CreateClientGatewayRequest
DeleteClientGatewayRequest
Message for deleting a ClientGateway
Protobuf type google.cloud.beyondcorp.clientgateways.v1.DeleteClientGatewayRequest
DeleteClientGatewayRequest.Builder
Message for deleting a ClientGateway
Protobuf type google.cloud.beyondcorp.clientgateways.v1.DeleteClientGatewayRequest
GetClientGatewayRequest
Message for getting a ClientGateway.
Protobuf type google.cloud.beyondcorp.clientgateways.v1.GetClientGatewayRequest
GetClientGatewayRequest.Builder
Message for getting a ClientGateway.
Protobuf type google.cloud.beyondcorp.clientgateways.v1.GetClientGatewayRequest
ListClientGatewaysRequest
Message for requesting list of ClientGateways.
Protobuf type google.cloud.beyondcorp.clientgateways.v1.ListClientGatewaysRequest
ListClientGatewaysRequest.Builder
Message for requesting list of ClientGateways.
Protobuf type google.cloud.beyondcorp.clientgateways.v1.ListClientGatewaysRequest
ListClientGatewaysResponse
Message for response to listing ClientGateways.
Protobuf type google.cloud.beyondcorp.clientgateways.v1.ListClientGatewaysResponse
ListClientGatewaysResponse.Builder
Message for response to listing ClientGateways.
Protobuf type google.cloud.beyondcorp.clientgateways.v1.ListClientGatewaysResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
Interfaces
ClientGatewayOperationMetadataOrBuilder
ClientGatewayOrBuilder
ClientGatewaysServiceGrpc.AsyncService
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}
.
CreateClientGatewayRequestOrBuilder
DeleteClientGatewayRequestOrBuilder
GetClientGatewayRequestOrBuilder
ListClientGatewaysRequestOrBuilder
ListClientGatewaysResponseOrBuilder
Enums
ClientGateway.State
Represents the different states of a gateway.
Protobuf enum google.cloud.beyondcorp.clientgateways.v1.ClientGateway.State