Class AppConnectionsServiceClient (0.42.0)

GitHub RepositoryProduct Reference

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().

Methods
Method Description Method Variants

ListAppConnections

Lists AppConnections in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAppConnections(ListAppConnectionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAppConnections(LocationName parent)

  • listAppConnections(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAppConnectionsPagedCallable()

  • listAppConnectionsCallable()

GetAppConnection

Gets details of a single AppConnection.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAppConnection(GetAppConnectionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAppConnection(AppConnectionName name)

  • getAppConnection(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAppConnectionCallable()

CreateAppConnection

Creates a new AppConnection in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAppConnectionAsync(CreateAppConnectionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createAppConnectionAsync(LocationName parent, AppConnection appConnection, String appConnectionId)

  • createAppConnectionAsync(String parent, AppConnection appConnection, String appConnectionId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAppConnectionOperationCallable()

  • createAppConnectionCallable()

UpdateAppConnection

Updates the parameters of a single AppConnection.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAppConnectionAsync(UpdateAppConnectionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateAppConnectionAsync(AppConnection appConnection, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAppConnectionOperationCallable()

  • updateAppConnectionCallable()

DeleteAppConnection

Deletes a single AppConnection.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAppConnectionAsync(DeleteAppConnectionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAppConnectionAsync(AppConnectionName name)

  • deleteAppConnectionAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAppConnectionOperationCallable()

  • deleteAppConnectionCallable()

ResolveAppConnections

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resolveAppConnections(ResolveAppConnectionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • resolveAppConnections(LocationName parent)

  • resolveAppConnections(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resolveAppConnectionsPagedCallable()

  • resolveAppConnectionsCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

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.

Inheritance

java.lang.Object > AppConnectionsServiceClient

Static Methods

create()

public static final AppConnectionsServiceClient create()

Constructs an instance of AppConnectionsServiceClient with default settings.

Returns
Type Description
AppConnectionsServiceClient
Exceptions
Type Description
IOException

create(AppConnectionsServiceSettings settings)

public static final AppConnectionsServiceClient create(AppConnectionsServiceSettings settings)

Constructs an instance of AppConnectionsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings AppConnectionsServiceSettings
Returns
Type Description
AppConnectionsServiceClient
Exceptions
Type Description
IOException

create(AppConnectionsServiceStub stub)

public static final AppConnectionsServiceClient create(AppConnectionsServiceStub stub)

Constructs an instance of AppConnectionsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AppConnectionsServiceSettings).

Parameter
Name Description
stub AppConnectionsServiceStub
Returns
Type Description
AppConnectionsServiceClient

Constructors

AppConnectionsServiceClient(AppConnectionsServiceSettings settings)

protected AppConnectionsServiceClient(AppConnectionsServiceSettings settings)

Constructs an instance of AppConnectionsServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings AppConnectionsServiceSettings

AppConnectionsServiceClient(AppConnectionsServiceStub stub)

protected AppConnectionsServiceClient(AppConnectionsServiceStub stub)
Parameter
Name Description
stub AppConnectionsServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createAppConnectionAsync(CreateAppConnectionRequest request)

public final OperationFuture<AppConnection,AppConnectionOperationMetadata> createAppConnectionAsync(CreateAppConnectionRequest request)

Creates a new AppConnection in a given project and location.

Sample code:


 // 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()) {
   CreateAppConnectionRequest request =
       CreateAppConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppConnectionId("appConnectionId-1293292198")
           .setAppConnection(AppConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   AppConnection response = appConnectionsServiceClient.createAppConnectionAsync(request).get();
 }
Parameter
Name Description
request CreateAppConnectionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<AppConnection,AppConnectionOperationMetadata>

createAppConnectionAsync(LocationName parent, AppConnection appConnection, String appConnectionId)

public final OperationFuture<AppConnection,AppConnectionOperationMetadata> createAppConnectionAsync(LocationName parent, AppConnection appConnection, String appConnectionId)

Creates a new AppConnection in a given project and location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   AppConnection appConnection = AppConnection.newBuilder().build();
   String appConnectionId = "appConnectionId-1293292198";
   AppConnection response =
       appConnectionsServiceClient
           .createAppConnectionAsync(parent, appConnection, appConnectionId)
           .get();
 }
Parameters
Name Description
parent LocationName

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}
appConnection AppConnection

Required. A BeyondCorp AppConnection resource.
appConnectionId String

Optional. User-settable AppConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
Returns
Type Description
OperationFuture<AppConnection,AppConnectionOperationMetadata>

createAppConnectionAsync(String parent, AppConnection appConnection, String appConnectionId)

public final OperationFuture<AppConnection,AppConnectionOperationMetadata> createAppConnectionAsync(String parent, AppConnection appConnection, String appConnectionId)

Creates a new AppConnection in a given project and location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   AppConnection appConnection = AppConnection.newBuilder().build();
   String appConnectionId = "appConnectionId-1293292198";
   AppConnection response =
       appConnectionsServiceClient
           .createAppConnectionAsync(parent, appConnection, appConnectionId)
           .get();
 }
Parameters
Name Description
parent String

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}
appConnection AppConnection

Required. A BeyondCorp AppConnection resource.
appConnectionId String

Optional. User-settable AppConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
Returns
Type Description
OperationFuture<AppConnection,AppConnectionOperationMetadata>

createAppConnectionCallable()

public final UnaryCallable<CreateAppConnectionRequest,Operation> createAppConnectionCallable()

Creates a new AppConnection in a given project and location.

Sample code:


 // 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()) {
   CreateAppConnectionRequest request =
       CreateAppConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppConnectionId("appConnectionId-1293292198")
           .setAppConnection(AppConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       appConnectionsServiceClient.createAppConnectionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateAppConnectionRequest,Operation>

createAppConnectionOperationCallable()

public final OperationCallable<CreateAppConnectionRequest,AppConnection,AppConnectionOperationMetadata> createAppConnectionOperationCallable()

Creates a new AppConnection in a given project and location.

Sample code:


 // 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()) {
   CreateAppConnectionRequest request =
       CreateAppConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppConnectionId("appConnectionId-1293292198")
           .setAppConnection(AppConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<AppConnection, AppConnectionOperationMetadata> future =
       appConnectionsServiceClient.createAppConnectionOperationCallable().futureCall(request);
   // Do something.
   AppConnection response = future.get();
 }
Returns
Type Description
OperationCallable<CreateAppConnectionRequest,AppConnection,AppConnectionOperationMetadata>

deleteAppConnectionAsync(AppConnectionName name)

public final OperationFuture<Empty,AppConnectionOperationMetadata> deleteAppConnectionAsync(AppConnectionName name)

Deletes a single AppConnection.

Sample code:


 // 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]");
   appConnectionsServiceClient.deleteAppConnectionAsync(name).get();
 }
Parameter
Name Description
name AppConnectionName

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}
Returns
Type Description
OperationFuture<Empty,AppConnectionOperationMetadata>

deleteAppConnectionAsync(DeleteAppConnectionRequest request)

public final OperationFuture<Empty,AppConnectionOperationMetadata> deleteAppConnectionAsync(DeleteAppConnectionRequest request)

Deletes a single AppConnection.

Sample code:


 // 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()) {
   DeleteAppConnectionRequest request =
       DeleteAppConnectionRequest.newBuilder()
           .setName(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   appConnectionsServiceClient.deleteAppConnectionAsync(request).get();
 }
Parameter
Name Description
request DeleteAppConnectionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,AppConnectionOperationMetadata>

deleteAppConnectionAsync(String name)

public final OperationFuture<Empty,AppConnectionOperationMetadata> deleteAppConnectionAsync(String name)

Deletes a single AppConnection.

Sample code:


 // 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()) {
   String name = AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString();
   appConnectionsServiceClient.deleteAppConnectionAsync(name).get();
 }
Parameter
Name Description
name String

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}
Returns
Type Description
OperationFuture<Empty,AppConnectionOperationMetadata>

deleteAppConnectionCallable()

public final UnaryCallable<DeleteAppConnectionRequest,Operation> deleteAppConnectionCallable()

Deletes a single AppConnection.

Sample code:


 // 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()) {
   DeleteAppConnectionRequest request =
       DeleteAppConnectionRequest.newBuilder()
           .setName(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       appConnectionsServiceClient.deleteAppConnectionCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteAppConnectionRequest,Operation>

deleteAppConnectionOperationCallable()

public final OperationCallable<DeleteAppConnectionRequest,Empty,AppConnectionOperationMetadata> deleteAppConnectionOperationCallable()

Deletes a single AppConnection.

Sample code:


 // 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()) {
   DeleteAppConnectionRequest request =
       DeleteAppConnectionRequest.newBuilder()
           .setName(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Empty, AppConnectionOperationMetadata> future =
       appConnectionsServiceClient.deleteAppConnectionOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteAppConnectionRequest,Empty,AppConnectionOperationMetadata>

getAppConnection(AppConnectionName name)

public final AppConnection getAppConnection(AppConnectionName name)

Gets details of a single AppConnection.

Sample code:


 // 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);
 }
Parameter
Name Description
name AppConnectionName

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}
Returns
Type Description
AppConnection

getAppConnection(GetAppConnectionRequest request)

public final AppConnection getAppConnection(GetAppConnectionRequest request)

Gets details of a single AppConnection.

Sample code:


 // 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()) {
   GetAppConnectionRequest request =
       GetAppConnectionRequest.newBuilder()
           .setName(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .build();
   AppConnection response = appConnectionsServiceClient.getAppConnection(request);
 }
Parameter
Name Description
request GetAppConnectionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AppConnection

getAppConnection(String name)

public final AppConnection getAppConnection(String name)

Gets details of a single AppConnection.

Sample code:


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

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}
Returns
Type Description
AppConnection

getAppConnectionCallable()

public final UnaryCallable<GetAppConnectionRequest,AppConnection> getAppConnectionCallable()

Gets details of a single AppConnection.

Sample code:


 // 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()) {
   GetAppConnectionRequest request =
       GetAppConnectionRequest.newBuilder()
           .setName(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .build();
   ApiFuture<AppConnection> future =
       appConnectionsServiceClient.getAppConnectionCallable().futureCall(request);
   // Do something.
   AppConnection response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAppConnectionRequest,AppConnection>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // 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()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = appConnectionsServiceClient.getIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // 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()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       appConnectionsServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // 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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = appConnectionsServiceClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // 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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       appConnectionsServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSettings()

public final AppConnectionsServiceSettings getSettings()
Returns
Type Description
AppConnectionsServiceSettings

getStub()

public AppConnectionsServiceStub getStub()
Returns
Type Description
AppConnectionsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listAppConnections(ListAppConnectionsRequest request)

public final AppConnectionsServiceClient.ListAppConnectionsPagedResponse listAppConnections(ListAppConnectionsRequest request)

Lists AppConnections in a given project and location.

Sample code:


 // 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()) {
   ListAppConnectionsRequest request =
       ListAppConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (AppConnection element :
       appConnectionsServiceClient.listAppConnections(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListAppConnectionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AppConnectionsServiceClient.ListAppConnectionsPagedResponse

listAppConnections(LocationName parent)

public final AppConnectionsServiceClient.ListAppConnectionsPagedResponse listAppConnections(LocationName parent)

Lists AppConnections in a given project and location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (AppConnection element :
       appConnectionsServiceClient.listAppConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}
Returns
Type Description
AppConnectionsServiceClient.ListAppConnectionsPagedResponse

listAppConnections(String parent)

public final AppConnectionsServiceClient.ListAppConnectionsPagedResponse listAppConnections(String parent)

Lists AppConnections in a given project and location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (AppConnection element :
       appConnectionsServiceClient.listAppConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}
Returns
Type Description
AppConnectionsServiceClient.ListAppConnectionsPagedResponse

listAppConnectionsCallable()

public final UnaryCallable<ListAppConnectionsRequest,ListAppConnectionsResponse> listAppConnectionsCallable()

Lists AppConnections in a given project and location.

Sample code:


 // 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()) {
   ListAppConnectionsRequest request =
       ListAppConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListAppConnectionsResponse response =
         appConnectionsServiceClient.listAppConnectionsCallable().call(request);
     for (AppConnection element : response.getAppConnectionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListAppConnectionsRequest,ListAppConnectionsResponse>

listAppConnectionsPagedCallable()

public final UnaryCallable<ListAppConnectionsRequest,AppConnectionsServiceClient.ListAppConnectionsPagedResponse> listAppConnectionsPagedCallable()

Lists AppConnections in a given project and location.

Sample code:


 // 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()) {
   ListAppConnectionsRequest request =
       ListAppConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<AppConnection> future =
       appConnectionsServiceClient.listAppConnectionsPagedCallable().futureCall(request);
   // Do something.
   for (AppConnection element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListAppConnectionsRequest,ListAppConnectionsPagedResponse>

listLocations(ListLocationsRequest request)

public final AppConnectionsServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : appConnectionsServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AppConnectionsServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         appConnectionsServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,AppConnectionsServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       appConnectionsServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

resolveAppConnections(LocationName parent)

public final AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse resolveAppConnections(LocationName parent)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ResolveAppConnectionsResponse.AppConnectionDetails element :
       appConnectionsServiceClient.resolveAppConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}
Returns
Type Description
AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse

resolveAppConnections(ResolveAppConnectionsRequest request)

public final AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse resolveAppConnections(ResolveAppConnectionsRequest request)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Sample code:


 // 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()) {
   ResolveAppConnectionsRequest request =
       ResolveAppConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppConnectorId(
               AppConnectorName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTOR]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ResolveAppConnectionsResponse.AppConnectionDetails element :
       appConnectionsServiceClient.resolveAppConnections(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ResolveAppConnectionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse

resolveAppConnections(String parent)

public final AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse resolveAppConnections(String parent)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ResolveAppConnectionsResponse.AppConnectionDetails element :
       appConnectionsServiceClient.resolveAppConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}
Returns
Type Description
AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse

resolveAppConnectionsCallable()

public final UnaryCallable<ResolveAppConnectionsRequest,ResolveAppConnectionsResponse> resolveAppConnectionsCallable()

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Sample code:


 // 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()) {
   ResolveAppConnectionsRequest request =
       ResolveAppConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppConnectorId(
               AppConnectorName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTOR]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ResolveAppConnectionsResponse response =
         appConnectionsServiceClient.resolveAppConnectionsCallable().call(request);
     for (ResolveAppConnectionsResponse.AppConnectionDetails element :
         response.getAppConnectionDetailsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ResolveAppConnectionsRequest,ResolveAppConnectionsResponse>

resolveAppConnectionsPagedCallable()

public final UnaryCallable<ResolveAppConnectionsRequest,AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse> resolveAppConnectionsPagedCallable()

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Sample code:


 // 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()) {
   ResolveAppConnectionsRequest request =
       ResolveAppConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppConnectorId(
               AppConnectorName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTOR]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ResolveAppConnectionsResponse.AppConnectionDetails> future =
       appConnectionsServiceClient.resolveAppConnectionsPagedCallable().futureCall(request);
   // Do something.
   for (ResolveAppConnectionsResponse.AppConnectionDetails element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ResolveAppConnectionsRequest,ResolveAppConnectionsPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // 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()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = appConnectionsServiceClient.setIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // 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()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       appConnectionsServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // 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()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = appConnectionsServiceClient.testIamPermissions(request);
 }
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // 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()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AppConnectionName.of("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       appConnectionsServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateAppConnectionAsync(AppConnection appConnection, FieldMask updateMask)

public final OperationFuture<AppConnection,AppConnectionOperationMetadata> updateAppConnectionAsync(AppConnection appConnection, FieldMask updateMask)

Updates the parameters of a single AppConnection.

Sample code:


 // 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()) {
   AppConnection appConnection = AppConnection.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AppConnection response =
       appConnectionsServiceClient.updateAppConnectionAsync(appConnection, updateMask).get();
 }
Parameters
Name Description
appConnection AppConnection

Required. AppConnection message with updated fields. Only supported fields specified in update_mask are updated.
updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnection]:

  • labels
  • display_name
  • application_endpoint
  • connectors

Returns
Type Description
OperationFuture<AppConnection,AppConnectionOperationMetadata>

updateAppConnectionAsync(UpdateAppConnectionRequest request)

public final OperationFuture<AppConnection,AppConnectionOperationMetadata> updateAppConnectionAsync(UpdateAppConnectionRequest request)

Updates the parameters of a single AppConnection.

Sample code:


 // 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()) {
   UpdateAppConnectionRequest request =
       UpdateAppConnectionRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAppConnection(AppConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   AppConnection response = appConnectionsServiceClient.updateAppConnectionAsync(request).get();
 }
Parameter
Name Description
request UpdateAppConnectionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<AppConnection,AppConnectionOperationMetadata>

updateAppConnectionCallable()

public final UnaryCallable<UpdateAppConnectionRequest,Operation> updateAppConnectionCallable()

Updates the parameters of a single AppConnection.

Sample code:


 // 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()) {
   UpdateAppConnectionRequest request =
       UpdateAppConnectionRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAppConnection(AppConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   ApiFuture<Operation> future =
       appConnectionsServiceClient.updateAppConnectionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateAppConnectionRequest,Operation>

updateAppConnectionOperationCallable()

public final OperationCallable<UpdateAppConnectionRequest,AppConnection,AppConnectionOperationMetadata> updateAppConnectionOperationCallable()

Updates the parameters of a single AppConnection.

Sample code:


 // 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()) {
   UpdateAppConnectionRequest request =
       UpdateAppConnectionRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAppConnection(AppConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   OperationFuture<AppConnection, AppConnectionOperationMetadata> future =
       appConnectionsServiceClient.updateAppConnectionOperationCallable().futureCall(request);
   // Do something.
   AppConnection response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateAppConnectionRequest,AppConnection,AppConnectionOperationMetadata>